https://github.com/KnisterPeter/react-to-typescript-definitions
Create typescript definitions files (d.ts) from react components
https://github.com/KnisterPeter/react-to-typescript-definitions
parser proptypes react typescript typescript-definitions
Last synced: about 1 year ago
JSON representation
Create typescript definitions files (d.ts) from react components
- Host: GitHub
- URL: https://github.com/KnisterPeter/react-to-typescript-definitions
- Owner: KnisterPeter
- License: mit
- Archived: true
- Created: 2015-12-02T00:53:38.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2023-11-27T13:00:45.000Z (over 2 years ago)
- Last Synced: 2025-03-08T13:05:16.655Z (over 1 year ago)
- Topics: parser, proptypes, react, typescript, typescript-definitions
- Language: TypeScript
- Size: 2.91 MB
- Stars: 238
- Watchers: 1
- Forks: 15
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# react-to-typescript-definitions
[![GitHub license][license-image]][license-link]
[![npm][npm-image]][npm-link]
[![Travis][ci-image]][ci-link]
[](https://codecov.io/gh/KnisterPeter/react-to-typescript-definitions)[![Commitizen friendly][commitizen-image]][commitizen-link]
[![Standard Version][standard-version-image]][standard-version-link]
[](https://renovateapp.com/)
Create typescript definitions files (d.ts) from react components.
## Features
- ES6 and ES7 class syntax
- Most PropTypes
- any, array, bool, func, number, object, string, node, element, oneOfType, arrayOf, symbol, shape
- Partial support for oneOf PropType
- required PropTypes
- instanceOf PropTypes (when using API and giving a resolve function)
- jsdoc
## Usage
### Installation
Install as npm package:
```sh
npm install react-to-typescript-definitions --save-dev
```
or
```sh
npm install -g react-to-typescript-definitions
```
### CLI
```sh
Usage
$ react2dts [--module-name | --top-level-module]
react2dts reads from stdin to process a file.
Options
--module-name, --name name of the module to create
--top-level-module if the created module should live in top-level
Examples
$ cat |react2dts --module-name module-name
$ cat |react2dts --top-level-module
```
### API
Functions:
```js
/**
* Returns the typescript definition for the given file.
*
* @param name The name of the generated module
* @param path The path to the file to parse
* @param options The options to use
* @return The type definition as string
*/
function generateFromFile(name, path, options)
```
```js
/**
* Returns the typescript definition for the given source.
*
* @param name The name of the generated module
* @param code The code to parse
* @param options The options to use
* @return The type definition as string
*/
function generateFromSource(name, code, options)
```
```js
/**
* Returns the typescript definition for the given babylon AST object.
*
* @param name The name of the generated module
* @param ast The babylon ASt to parse
* @param options The options to use
* @return The type definition as string
*/
function generateFromAst(name, ast, options)
```
Options:
- instanceOfResolver
A function which gets a type name (as string) and should return the path
to the file defining the type or undefined if the type is not resolvable.
This function is required to generate instanceOf PropTypes.
[license-image]: https://img.shields.io/github/license/KnisterPeter/react-to-typescript-definitions.svg
[license-link]: https://github.com/KnisterPeter/react-to-typescript-definitions
[npm-image]: https://img.shields.io/npm/v/react-to-typescript-definitions.svg
[npm-link]: https://www.npmjs.com/package/react-to-typescript-definitions
[ci-image]: https://img.shields.io/travis/KnisterPeter/react-to-typescript-definitions.svg
[ci-link]: https://travis-ci.org/KnisterPeter/react-to-typescript-definitions
[commitizen-image]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg
[commitizen-link]: http://commitizen.github.io/cz-cli/
[standard-version-image]: https://img.shields.io/badge/release-standard%20version-brightgreen.svg
[standard-version-link]: https://github.com/conventional-changelog/standard-version