Skip to content

Fix doc for creating a subscription in javascript #658

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 2 commits into from
Jul 31, 2019
Merged

Fix doc for creating a subscription in javascript #658

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
14d8f58
Fix doc for creating a subscription in javascript
davimacedo Jul 31, 2019
b41c8bf
Note about release 2.3.0
davimacedo Jul 31, 2019
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: 3 additions & 1 deletion _includes/js/live-queries.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,11 @@ Note: Live Queries is supported only in [Parse Server](https://github.com/parse-

```javascript
let query = new Parse.Query('Game');
let subscription = query.subscribe();
let subscription = await query.subscribe();
```

* Since release `2.3.0` of Parse JS SDK, the `query.subscribe()` function returns a `Promise` that resolves to the subscription object. Previous releases return the subscription object directly and require you to write `let subscription = query.subscribe();` instead.

The subscription you get is actually an event emitter. For more information on event emitter, check [here](https://nodejs.org/api/events.html). You'll get the LiveQuery events through this `subscription`. The first time you call subscribe, we'll try to open the WebSocket connection to the LiveQuery server for you.

## Event Handling
Expand Down