Skip to content

clarified DataStore selective sync reevaluation language #5282

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 23, 2023
Merged

clarified DataStore selective sync reevaluation language #5282

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9dd5f53
clarified DataStore selective sync reevaluation language
svidgen Mar 22, 2023
2985b46
fixed word tense typo
svidgen Mar 22, 2023
e4077b8
Update src/fragments/lib/datastore/js/sync/50-selectiveSync.mdx
svidgen Mar 22, 2023
3996375
Update src/fragments/lib/datastore/js/sync/50-selectiveSync.mdx
svidgen Mar 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/fragments/lib/datastore/js/sync/50-selectiveSync.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,9 @@ async function changeSync() {
};
```

Upon calling `DataStore.start()` (or executing a DataStore operation, e.g., `query`, `save`, `delete`, or `observe`), DataStore will reevaluate the `syncExpressions`.
Calls to `start`, `query`, `save`, `delete`, `observe`, and `observeQuery` will only start DataStore and reevaluate sync expressions if DataStore is not already started.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit:

Suggested change
Calls to `start`, `query`, `save`, `delete`, `observe`, and `observeQuery` will only start DataStore and reevaluate sync expressions if DataStore is not already started.
Calls to `start`, `query`, `save`, `delete`, `observe`, and `observeQuery` will only start DataStore and re-evaluate sync expressions if DataStore is not already started.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm deferring to the spelling from the header here, which I think is in line with the guidance from the style guide entry on hyphenated words.


In the above case, the predicate will contain the value `1`, so all Posts with `rating > 1` will get synced down.
In the example above, `changeSync()` invokes `DataStore.start()` after `DataStore.stop()` has completely finished. This causes sync expressions to be reevaluated. Subsequently, when the sync expression is reevaluated, the `rating` variable has been changed to `1`, so all Posts with `rating > 1` will get synced down.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sam here

Suggested change
In the example above, `changeSync()` invokes `DataStore.start()` after `DataStore.stop()` has completely finished. This causes sync expressions to be reevaluated. Subsequently, when the sync expression is reevaluated, the `rating` variable has been changed to `1`, so all Posts with `rating > 1` will get synced down.
In the example above, `changeSync()` invokes `DataStore.start()` after `DataStore.stop()` has completely finished. This causes sync expressions to be re-evaluated. Subsequently, when the sync expression is re-evaluated, the `rating` variable has been changed to `1`, so all Posts with `rating > 1` will get synced down.


Keep in mind: `DataStore.stop()` will retain the local store's existing content. Run `DataStore.clear()` to clear the locally-stored contents.

Expand Down