React prop-types with metadata inside ✨

It is a drop-in replacement for prop-types that includes metadata to generate documentation from prop-types consistently.

npm install prop-desc prop-types

importReactfrom'react'importPropTypesfrom'prop-desc'functionMyComponent(){// ... do things with the props}MyComponent.propTypes={optionalArray: PropTypes.array,optionalBool: PropTypes.bool,optionalFunc: PropTypes.func,}console.log(PropTypes.getMetadata(MyComponent.propTypes))

Generating documentation from prop types is useful but not easy. A project call react-docgen try to introspect code to extract type but it remains static and does not work with complex prop types (in other files). prop-desc solves this and permits to generate consistent documentation from your prop-types.

MIT