fbredius/storybook

View on GitHub
addons/docs/src/lib/docgen/PropDef.ts

Summary

Maintainability
A
0 mins
Test Coverage
// FIXME: this is legacy code that needs to be updated & simplified with ArgType refactor

export interface JsDocParam {
  name: string;
  description?: string;
}

export interface JsDocReturns {
  description?: string;
}

export interface JsDocTags {
  params?: JsDocParam[];
  returns?: JsDocReturns;
}

export interface PropSummaryValue {
  summary: string;
  detail?: string;
}

export type PropType = PropSummaryValue;
export type PropDefaultValue = PropSummaryValue;

export interface PropDef {
  name: string;
  type: PropType;
  sbType?: any;
  required: boolean;
  description?: string;
  defaultValue?: PropDefaultValue;
  jsDocTags?: JsDocTags;
}