Skip to content

Commit 6b05a77

Browse files
docs(NODE-6888): update API docs for disambiguatedPaths on 8.2.0+ servers (#4502)
1 parent cb88b05 commit 6b05a77

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

src/change_stream.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -521,8 +521,12 @@ export interface UpdateDescription<TSchema extends Document = Document> {
521521
* }
522522
* ```
523523
*
524-
* This field is only present when there are ambiguous paths that are updated as a part of the update event and `showExpandedEvents`
524+
* This field is only present when there are ambiguous paths that are updated as a part of the update event.
525+
*
526+
* On \<8.2.0 servers, this field is only present when `showExpandedEvents` is set to true.
525527
* is enabled for the change stream.
528+
*
529+
* On 8.2.0+ servers, this field is present for update events regardless of whether `showExpandedEvents` is enabled.
526530
* @sinceServerVersion 6.1.0
527531
*/
528532
disambiguatedPaths?: Document;

0 commit comments

Comments
 (0)