Get Flow built-in type definition files
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
img
src
test_env
.all-contributorsrc
.eslintignore
.eslintrc
.gitignore
.npmignore
LICENSE
README.md
package.json
yarn.lock

README.md

Flow Typedef · npm version CircleCI All Contributors PRs Welcome

get Flow built-in type definition files.

Why

Flow Buit-in type definition files are hosted facebook/flow.
If you would like to get those files some reason, you have to manual copy.

Getting Started

I Assume you have experience of flow-typed. Otherwise you might be start from flow-typed.

Install

recommend global install

$ yarn global add flow-typedef

Usage

In the same directory as package.json that flow-bin installed(almost where is project root), execute flow-typedef command. Then typedef files will be generated under the flow-typed/built-in.

# cd your-project-dir
$ flow-typedef

flow-typedef detect your flow-bin version and get same version typedef files.

And more, I reccomend following setting.

// .flowconfig

[ignore]

[include]

[libs]

[lints]

[options]
no_flowlib=true

[strict]

Because Flow built in lib def already there in your /flow-typed.
see option detail https://flow.org/en/docs/config/options/#toc-no-flowlib-boolean

Contributors

Thanks goes to these wonderful people (emoji key):


ryota-murakami

💻 📖 ⚠️

This project follows the all-contributors specification. Contributions of any kind welcome!