Repository files navigation

Arepository of high-quality, third-partylibrary type definitions for use withFlow.

And with it comes new features, most notably the support fordefinition dependencies.

Learn how to add dependencies to a definition from themain branchdocs which can be consumed with thev4 CLI.

$ yarn global add flow-typed@next# or$ npm install -g flow-typed@next

Nothing for the most part! CLI versions <v4 will still pull definitions frommaster so if you have library definitions that don't require dependencies we still recommend you contribute tomaster and it'll get periodically synced back tomain for users >=v4.

Eventually we will deprecatemaster in favour ofmain.

Check out thequick start pagein the docs to get started. It will walk you through installing typedefs, using them,as well as writing and including your own.

When you start a project with Flow,you likely want to use some third-partylibraries that werenot written with Flow. By default, Flow will just ignorethese librariesleaving them untyped. As a result, Flow can't give errors ifyou accidentally mis-use the library (nor will it be able to auto-complete thelibrary).

To address this,Flow supportslibrary definitions which allowyou to describe the interface of a module or library separate from theimplementation of that module/library.

Theflow-typed repo is a collection of high-quality library definitions,tests to ensure that definitions remain high quality, and tooling to make itas easy as possible to import them into your project.

All you have to do when you add one or more new dependencies to your projectis runflow-typed install. This will search the libdef repo and download allthe libdefs that are relevant for your project and install them for you. Afterthat,simply check them in and be on your way!

Theflow-typed npm package provides a CLI that includes several commands forworking with this repository. The full list of commands is availablein the docs .

Before opening an issue, take a look at theFAQs.Chances are your question has already been answered! If not, don't hesitate toopen an issue.

Just send a pull request! The documentation highlighted inCONTRIBUTING.md should give a detailed overview of how to raise a pull request following our best practices.

Bugfixes and improvements to the core CLI are welcome. If you'd like to contributea new feature, consider opening an issue first to discuss it.

@AndrewSouthpaw	@Brianzchen	@GAntoine	@pascalduez	@villesau