Skip to content

Commit

Permalink
docs(ChangeStream): fix typos in ChangeStream docs
Browse files Browse the repository at this point in the history
  • Loading branch information
daprahamian committed Aug 13, 2019
1 parent 26a38e5 commit 7f471ac
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions lib/change_stream.js
Original file line number Diff line number Diff line change
Expand Up @@ -105,13 +105,13 @@ class ResumeTokenTracker extends EventEmitter {

/**
* @typedef OperationTime
* @description Represents a specific point in time on a server. Can be retrieve by using {@link Db#command}
* @description Represents a specific point in time on a server. Can be retrieved by using {@link Db#command}
* @see https://docs.mongodb.com/manual/reference/method/db.runCommand/#response
*/

/**
* @typedef ChangeStreamOptions
* @description Options that can be passed to a ChangeSream. Note that startAfter, resumeAfter, and startAtOperationTime are all mutually exclusive, and the server will error if more than one is specified.
* @description Options that can be passed to a ChangeStream. Note that startAfter, resumeAfter, and startAtOperationTime are all mutually exclusive, and the server will error if more than one is specified.
* @property {string} [fullDocument='default'] Allowed values: ‘default’, ‘updateLookup’. When set to ‘updateLookup’, the change stream will include both a delta describing the changes to the document, as well as a copy of the entire document that was changed from some time after the change occurred.
* @property {number} [maxAwaitTimeMS] The maximum amount of time for the server to wait on new documents to satisfy a change stream query.
* @property {ResumeToken} [resumeAfter] Allows you to start a changeStream after a specified event. See {@link https://docs.mongodb.com/master/changeStreams/#resumeafter-for-change-streams|ChangeStream documentation}.
Expand Down

0 comments on commit 7f471ac

Please sign in to comment.