Add documentation #11
Merged
Conversation
This file contains 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 28 commits
December 18, 2016 21:04
talyssonoc
previously requested changes
Dec 28, 2016
|
|
||
| ## Coercion | ||
|
|
||
| Structure does type coercion based on the declared [schema](#schema). It's important to note that it __never__ coerces `undefined` and it also won't coerce if the value is already of the declared type (except for arrays, we'll talk more about this soon). Let's break the coercion into 3 categories: |
There was a problem hiding this comment.
The link for schema have to be fixed to point to #schema-concept.
| generateRandomBook() { | ||
| return '...'; | ||
| } | ||
| } |
There was a problem hiding this comment.
I think there's something missing here, maybe it was supposed to be this?
const User = attributes(userSchema)(class User {
// ...
});|
|
||
| ## Getting started | ||
|
|
||
| `npm install structure` |
There was a problem hiding this comment.
Can we add --save option here? And maybe an example using Yarn?
Fix `defaultValue` to `default`.
fernandofleury
commented
Jan 1, 2017
|
@fernandofleury I think it is, using |
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.
No description provided.