Add docs for Record flow types #1343
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added a section to the Record documentation describing how to use `RecordFactory<T>` and `RecordOf<T>` and updated some flow tests to better match those usages.
rgbkrk
reviewed
Oct 5, 2017
| * **Flow Typing Records:** | ||
| * | ||
| * Immutable.js exports two Flow types designed to make it easier to use | ||
| * Records with flow typed code, `RecordOf<T>` and `RecordFactory<T>`. |
There was a problem hiding this comment.
Oh my gosh, thank you I've been hoping for this.
rgbkrk
reviewed
Oct 5, 2017
| * | ||
| * // Use RecordOf<T> for defining new instances of that Record. | ||
| * export type Point3D = RecordOf<Point3DFields>; | ||
| * const some3DPoint: Point3D = makePoint3D({ x: 10, y: 20, z: 30 }); |
There was a problem hiding this comment.
Check it out @peggyrayzis! Well typed Records!
rgbkrk
approved these changes
Oct 5, 2017
|
Thanks for the extra pair of eyes, @rgbkrk! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added a section to the Record documentation describing how to use
RecordFactory<T>andRecordOf<T>and updated some flow tests to better match those usages.