Add JS Doc for Local Datastore #558
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
acinader
reviewed
Oct 4, 2018
acinader
suggested changes
Feb 13, 2019
_includes/js/local-datastore.md
Outdated
|
|
||
| ## Pinning with Labels | ||
|
|
||
| Manually pinning and unpinning each object individual is a bit like using `malloc` and `free`. It is a very powerful tool, but it can be difficult to manage what objects get stored in complex scenarios. For example, imagine you are making a game with separate high score lists for global high scores and your friends' high scores. If one of your friends happens to have a globally high score, you need to make sure you don't unpin them completely when you remove them from one of the cached queries. To make these scenarios easier, you can also pin with a label. Labels indicate a group of objects that should be stored together. |
There was a problem hiding this comment.
individualshould beindividually- the example of 'malloc' and 'free' should be removed. only a very very small percentage of readers will even know what that is anymore ;). its not adding value here either.
- I don't follow your example. Can you try to re-write it to make the issue more clear (again, I'm not sure what the issue you're trying to point out is)
There was a problem hiding this comment.
I made the changes and added another section
_includes/js/local-datastore.md
Outdated
| await Parse.Object.unPinAllObjectsWithName('MyScores'); | ||
| ``` | ||
|
|
||
| Any object will stay in the datastore as long as it is pinned with any label. In other words, if you pin an object with two different labels, and then unpin it with one label, the object will stay in the datastore until you also unpin it with the other label. |
There was a problem hiding this comment.
Rather than Any object, just Objects
here's a take at re-writing:
An Object will be kept in the datastore as long as it is pinned by at least one label. So an object pinned with two labels will stay in the datastore if one of the two labels is unpinned.
acinader
approved these changes
Feb 13, 2019
_includes/js/local-datastore.md
Outdated
| await anotherGameScore.pinWithName('MyScores'); | ||
| ``` | ||
|
|
||
| To unpin all of the objects with the same label at the same time, you can pass a label to the unpin methods. This saves you from having to manually track which objects are in each group you care about. |
dplewis
changed the title
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.
parse-community/Parse-SDK-JS#612