Important: This documentation covers Yarn 1 (Classic).

For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

extract-react-types

atlassian532Apache-2.00.30.3

Parse prop-types from react components using typescript or flow

react, flow, typescript, prop-types, documentation

readme

extract-react-types

Extract Flow & TypeScript types from React Components

Features

Supports flow and typescript
Extracts the description of the props too ( Great for documentation )

Usage

$ yarn add extract-react-types

// Component.js

class Component extends React.Component<{ foo: boolean }> {}

Output:

{
  "kind": "program",
  "classes": [
    {
      "kind": "object",
      "members": [
      {
        "kind": "property",
        "key": {
        "kind": "id",
        "name": "foo"
        },
        "value": {
        "kind": "boolean"
        },
        "optional": false
      }
      ],
      "name": {
      "kind": "id",
      "name": "Component",
      "type": null
      }
    }
  ]
}