4.0.3 • Published 4 years ago

@component-controls/react-docgen-typescript-info v4.0.3

Weekly downloads
12
License
MIT
Repository
github
Last release
4 years ago

Table of contents

Overview

Extract props info from react typescript components:

Installation

This package is usually installed as part of the @component-controls package, but you can also install it standalone to extract props info from react typescript components

$ npm install @component-controls/react-docgen-typescript-info --save-dev

API

run

function

run API to generate react-docgen-typescript props information tables.

defined in @component-controls/react-docgen-typescript-info/props-info/react-docgen-typescript/src/index.ts

parameters

NameTypeDescription
optionstypetransformProps: function (props*: ComponentDoc[]) => ComponentDocexpression: ts.SymboldisplayName*: stringfilePath*: stringdescription*: stringprops*[string]: Tmethods*: Method[]tags[string]: TpropFilter: StaticPropFilter | PropFiltercomponentNameResolver: function (exp*: Symbolsource*: SourceFile) => string | undefined | null | falseshouldExtractLiteralValuesFromEnum: booleanshouldRemoveUndefinedFromOptional: booleanshouldExtractValuesFromUnion: booleanskipChildrenPropWithoutDoc: booleansavePropValueAsString: booleanshouldIncludePropTagMap: booleanshouldIncludeExpression: booleancustomComponentTypes: string[]configuration options
returnsPropsInfoExtractorFunctiona callable function of type PropsInfoExtractorFunction
@component-controls/corereact-docgen-typescript
@infinitebrahmanuniverse/nolb-_compo@everything-registry/sub-chunk-193@zalastax/nolb-_compo@component-controls/webpack-configs
4.0.3

4 years ago

3.12.0

5 years ago

3.14.0

5 years ago

3.14.2

5 years ago

3.14.5

5 years ago

3.14.6

5 years ago

3.13.0

5 years ago

3.11.4

5 years ago

3.9.0

5 years ago

3.8.0

5 years ago

3.10.0

5 years ago

3.10.3

5 years ago

3.10.2

5 years ago

3.8.2

5 years ago

3.11.0

5 years ago

3.7.0

5 years ago

3.6.3

5 years ago

3.6.2

5 years ago

3.6.0

5 years ago

3.5.0

5 years ago

3.4.2

5 years ago

3.4.1

5 years ago

3.4.0

5 years ago

3.2.0

5 years ago

3.3.0

5 years ago

3.1.5

5 years ago

3.1.0

5 years ago

2.13.0

5 years ago

2.10.4

5 years ago

2.9.0

5 years ago

2.8.0

5 years ago

2.7.0

5 years ago

2.6.3

5 years ago

2.6.2

5 years ago

2.6.0

5 years ago

2.5.0

5 years ago

2.4.0

5 years ago

2.3.0

5 years ago

2.2.1

5 years ago

2.2.0

5 years ago

2.0.1

5 years ago

2.1.0

5 years ago

2.0.0

5 years ago

1.44.0

5 years ago

1.43.0

5 years ago

1.42.12

5 years ago

1.42.9

5 years ago

1.42.0

5 years ago

1.41.0

5 years ago

1.40.2

5 years ago

1.40.3

5 years ago

1.39.3

5 years ago

1.39.4

5 years ago

1.38.0

5 years ago

1.37.0

5 years ago

1.36.14

5 years ago

1.36.8

5 years ago

1.36.5

5 years ago

1.36.6

5 years ago

1.36.0

5 years ago

1.35.1

5 years ago

1.35.0

5 years ago

1.34.0

5 years ago

1.32.1

5 years ago

1.32.5

5 years ago

1.32.2

5 years ago

1.32.3

5 years ago

1.31.3

5 years ago

1.31.2

5 years ago

1.30.0

5 years ago

1.29.0

5 years ago

1.28.0

5 years ago

1.27.3

5 years ago

1.26.0

5 years ago

1.25.0

5 years ago

1.24.6

5 years ago

1.22.0

5 years ago

1.21.0

5 years ago

1.20.0

5 years ago

1.19.3

5 years ago

1.19.5

5 years ago

1.19.2

5 years ago

1.19.1

5 years ago

1.19.0

5 years ago

1.18.1

5 years ago

1.18.0

5 years ago

1.18.3

5 years ago

1.18.2

5 years ago

1.16.3

5 years ago

1.17.0

5 years ago

1.16.2

5 years ago

1.16.1

5 years ago

1.16.0

5 years ago

1.15.0

5 years ago

1.14.1

5 years ago

1.14.0

5 years ago

1.13.4

5 years ago

1.13.3

5 years ago

1.11.0

5 years ago

1.10.3

5 years ago

1.10.0

5 years ago

1.9.0

5 years ago

1.8.0

5 years ago

1.7.0

5 years ago

1.6.0

5 years ago

1.5.7

5 years ago

1.5.1

5 years ago

1.5.0

5 years ago

1.4.0

5 years ago

1.3.0

5 years ago

1.2.0

5 years ago

1.1.0

6 years ago

1.0.1

6 years ago

0.9.0

6 years ago

0.8.0

6 years ago

0.7.1

6 years ago