Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/flow-typed/flow-typed

A central repository for Flow library definitions
https://github.com/flow-typed/flow-typed

cli flow flowtype hacktoberfest libdefs types

Last synced: 4 days ago
JSON representation

A central repository for Flow library definitions

Awesome Lists containing this project

README 

        


  

    flow-typed

  






  A repository of

  high-quality, third-party library type definitions

  for use with Flow.






  

    ci status

  

  npm package

  docs

  

    discord

  

  

    package health

  




> [!NOTE]  

> We want to keep the flow-typed community informed about the current state and future direction of the project. As you might have noticed, our activity has slowed down in recent months. However, we are committed to maintaining the functionality of flow-typed and will continue to fix any issues that arise with new releases of Flow.

>

> While we're not planning any major new features at the moment, we remain open to feature contributions from the community. Our focus remains on ensuring that the existing features work well and that type definitions are kept up to date. We appreciate the value that these contributions bring and encourage anyone interested in enhancing flow-typed to get involved.



Check out the [quick start](https://flow-typed.github.io/flow-typed/#/quickstart) page

in the docs to get started. It will walk you through installing typedefs, using them,

as well as writing and including your own.



## Huh?



When you start a project with Flow, **you likely want to use some third-party

libraries that were *not* written with Flow**. By default, Flow will just ignore

these libraries **leaving them untyped**. As a result, Flow can't give errors if

you accidentally mis-use the library (nor will it be able to auto-complete the

library).



To address this, **Flow supports

[library definitions](https://flow.org/en/docs/libdefs)** which allow

you to describe the interface of a module or library separate from the

implementation of that module/library.



**The `flow-typed` repo is a collection of high-quality library definitions**,

tests to ensure that definitions remain high quality, and tooling to make it

as easy as possible to import them into your project.



All you have to do when you add one or more new dependencies to your project

is run `flow-typed install`. This will search the libdef repo and download all

the libdefs that are relevant for your project and install them for you. After

that, **simply check them in** and be on your way!



## The CLI



The `flow-typed` npm package provides a CLI that includes several commands for

working with this repository. The full list of commands is available

[in the docs](https://flow-typed.github.io/flow-typed/#/install) .



## FAQs



Before opening an issue, take a look at the [FAQs](https://flow-typed.github.io/flow-typed/#/faq).

Chances are your question has already been answered! If not, don't hesitate to

[open an issue](https://github.com/flow-typed/flow-typed/issues/new).



## How Do I Contribute Library Definitions?



Just send a pull request! The documentation highlighted in [CONTRIBUTING.md](https://github.com/flow-typed/flow-typed/blob/main/CONTRIBUTING.md) should give a detailed overview of how to raise a pull request following our best practices.



### Contributing to the CLI



Bugfixes and improvements to the core CLI are welcome. If you'd like to contribute

a new feature, consider opening an issue first to discuss it.



## Active Maintenance Team



[![Andrew Smith](https://github.com/andrewsouthpaw.png?size=100)](https://github.com/andrewsouthpaw) | [![Brian Chen](https://github.com/Brianzchen.png?size=100)](https://github.com/Brianzchen)  | [![Georges-Antoine Assi](https://github.com/gantoine.png?size=100)](https://github.com/gantoine) | [![Pascal Duez](https://github.com/pascalduez.png?size=100)](https://github.com/pascalduez) | [![Ville Saukkonen](https://github.com/villesau.png?size=100)](https://github.com/villesau)

:---:|:---:|:---:|:---:|:---:

[@AndrewSouthpaw](https://github.com/andrewsouthpaw) | [@Brianzchen](https://github.com/Brianzchen) | [@GAntoine](https://github.com/gantoine) | [@pascalduez](https://github.com/pascalduez) | [@villesau](https://github.com/villesau)