Skip to content

Commit 6264564

Browse files
committed
Add basic documentation page for Flow. Closes #57
1 parent 04bfee9 commit 6264564

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

site/jekyll/guides/flow.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
layout: docs
3+
title: Flow
4+
---
5+
6+
ReactJS.NET has support for stripping out [Flow](http://flowtype.org/) type
7+
annotations from your code. Flow is an open-source static type checker for
8+
JavaScript developed by Facebook. It adds static typing to JavaScript to improve
9+
developer productivity and code quality. You can learn more about Flow in
10+
[its release announcement](https://code.facebook.com/posts/1505962329687926/flow-a-new-static-type-checker-for-javascript/).
11+
12+
How To Use It
13+
-------------
14+
Support for Flow is disabled by default. If you would like to use Flow type
15+
annotations, you must enable it in your site's configuration (normally
16+
`ReactConfig.cs`):
17+
18+
```csharp
19+
ReactSiteConfiguration.Configuration.SetStripTypes(true);
20+
```
21+
22+
This basically does the same thing as the offline transform tool mentioned in
23+
[the Flow documentation](http://flowtype.org/docs/running.html) so you do
24+
**not** need to run that tool manually.

0 commit comments

Comments
 (0)