[DOCS-12248] Changestream documents for Node ignores event-based API Created: 07/Dec/18 Updated: 30/Oct/23 Resolved: 15/Jan/19 |
|
| Status: | Closed |
| Project: | Documentation |
| Component/s: | manual, Server |
| Affects Version/s: | None |
| Fix Version/s: | Server_Docs_20231030 |
| Type: | Bug | Priority: | Major - P3 |
| Reporter: | Matt Broadstone | Assignee: | Kay Kim (Inactive) |
| Resolution: | Fixed | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Participants: | |
| Days since reply: | 5 years, 4 weeks, 1 day ago |
| Epic Link: | DOCSP-1769 |
| Description |
DescriptionWhen we generated change streams examples for the Node.js driver, we provided at least two different approaches: using cursors as an iterator, and using the resulting cursor as an event emitter. The Event Emitter approach is far more idiomatic in node, and I think should be represented in our documentation. For reference, I'm looking here: https://docs.mongodb.com/manual/changeStreams/ We recommend this as the basic example:
But the preferred form is:
Scope of changesImpact to Other DocsMVP (Work and Date)Resources (Scope or Design Docs, Invision, etc.) |
| Comments |
| Comment by Githook User [ 15/Jan/19 ] |
|
Author: {'email': 'kay.kim@mongodb.com', 'name': 'Kay Kim'}Message: |
| Comment by Githook User [ 15/Jan/19 ] |
|
Author: {'email': 'kay.kim@mongodb.com', 'name': 'Kay Kim'}Message: |
| Comment by Githook User [ 15/Jan/19 ] |
|
Author: {'email': 'kay.kim@mongodb.com', 'name': 'Kay Kim'}Message: |
| Comment by Kay Kim (Inactive) [ 15/Jan/19 ] |
|
Great. Will publish. |
| Comment by Matt Broadstone [ 15/Jan/19 ] |
|
kay.kim thanks for pointing that out! It's fixed now in master. |
| Comment by Githook User [ 14/Jan/19 ] |
|
Author: {'username': 'mbroadst', 'email': 'mbroadst@gmail.com', 'name': 'Matt Broadstone'}Message: doc(change-streams): update change streams examples to use streams Prefer use of streams to iterators, and document both approaches
|
| Comment by Githook User [ 12/Dec/18 ] |
|
Author: {'name': 'Matt Broadstone', 'email': 'mbroadst@gmail.com', 'username': 'mbroadst'}Message: doc(change-streams): update change streams examples to use streams Prefer use of streams to iterators, and document both approaches
|
| Comment by Githook User [ 11/Dec/18 ] |
|
Author: {'name': 'Matt Broadstone', 'email': 'mbroadst@gmail.com', 'username': 'mbroadst'}Message: doc(change-streams): update change streams examples to use streams Prefer use of streams to iterators, and document both approaches
|