Add API docs for the RecordReference #4641
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
pangratz
suggested changes
Nov 17, 2016
| ``` | ||
|
|
||
| @method id | ||
| @return {String} The id of the record in this belongsTo relationship. |
There was a problem hiding this comment.
s/ in this belongsTo relationship.//
| RecordReference.prototype.id = function() { | ||
| return this._id; | ||
| }; | ||
|
|
||
| /** | ||
| How the reference will be looked up with it is loaded: |
There was a problem hiding this comment.
...up with when it is loaded:... ?
| /** | ||
| How the reference will be looked up with it is loaded: | ||
|
|
||
| * `link`, a URL |
There was a problem hiding this comment.
Hmm, I believe that this is not supported at the moment. At least I am not aware of this... What am I missing?
| var userRef = store.getReference('user', 1); | ||
|
|
||
| // provide data for reference | ||
| userRef.push({ id: 1, username: "@user" }).then(function(user) { |
There was a problem hiding this comment.
The data passed to push needs to be a JSON-API doc with { data: { ... } }
| RecordReference.prototype.push = function(objectOrPromise) { | ||
| return Ember.RSVP.resolve(objectOrPromise).then((data) => { | ||
| return this.store.push(data); | ||
| }); | ||
| }; | ||
|
|
||
| /** | ||
| If the entity referred to by the reference is already loaded, it is | ||
| present as `reference.value`. Otherwise, the value of this property |
There was a problem hiding this comment.
I would change this to: Otherwise the value returned by this function is null
bmac
force-pushed
the
record-reference-api-docs
branch
2 times, most recently
from
3e9a39c
to
717bdff
Compare
bmac
force-pushed
the
record-reference-api-docs
branch
from
717bdff
to
4fc9133
Compare
|
@pangratz can you re-review? |
pangratz
approved these changes
Nov 20, 2016
|
Thanks again @bmac |
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.