Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Flow support instructions #1296

Merged
merged 1 commit into from
Jan 11, 2018
Merged

Update Flow support instructions #1296

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,13 @@ And finally kudos for all the people that believed in, tried, validated and even
* Use `npm test` to run the basic test suite, `npm run coverage` for the test suite with coverage and `npm run perf` for the performance tests.

## Flow support
MobX ships with flow typings. Flow will automatically include them. Though you cannot ignore `node_modules` in your `.flowconfig` and a you **cannot** import it explicitly in the `[libs]` section.
MobX ships with [flow typings](flow-typed/mobx.js). Flow will automatically include them when you import mobx modules. Although you **do not** need to import the types explicitly, you can still do it like this: `import type { ... } from 'mobx'`.

To use the [flow typings](flow-typed/mobx.js) shipped with MobX:

* In `.flowconfig`, you **cannot** ignore `node_modules`.
* In `.flowconfig`, you **cannot** import it explicitly in the `[libs]` section.
* You **do not** need to install library definition using [flow-typed](https://github.com/flowtype/flow-typed).

## Bower support

Expand Down