Skip to content

📜 Create TypeScript declaration files for React modules written in ES.Next.

License

Notifications You must be signed in to change notification settings

unstubbable/declare-react-module

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

60 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

declare-react-module

npm build codecov semantic-release

Create TypeScript declaration files for React modules written in ES.Next (stage 2).

Usage

Locally

  1. Install declare-react-module as a dev dependency:

    npm install --save-dev declare-react-module
  2. Add a new entry to "scripts" in your package.json:

    {
      "prepublish": "declare-react-module"
    }

This will create an index.d.ts file in your project root before publishing to npm.

As a Global Script

  1. Install declare-react-module as a global dependency:

    npm install --global declare-react-module
  2. Run declare-react-module from the command line:

    declare-react-module packages/my-package
    # or
    declare-react-module node_modules/some-module --outDir=./typings