Skip to content

Commit 92c013e

Browse files
authored
docs(NODE-5368): fix includeResultMetadata docs (#3737)
1 parent c6adad9 commit 92c013e

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

src/operations/find_and_modify.ts

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,10 @@ export interface FindOneAndDeleteOptions extends CommandOperationOptions {
2929
sort?: Sort;
3030
/** Map of parameter names and values that can be accessed using $$var (requires MongoDB 5.0). */
3131
let?: Document;
32-
/** Return the raw result document instead of the ModifyResult */
32+
/**
33+
* Return the ModifyResult instead of the modified document. Defaults to true
34+
* but will default to false in the next major version.
35+
*/
3336
includeResultMetadata?: boolean;
3437
}
3538

@@ -49,7 +52,10 @@ export interface FindOneAndReplaceOptions extends CommandOperationOptions {
4952
upsert?: boolean;
5053
/** Map of parameter names and values that can be accessed using $$var (requires MongoDB 5.0). */
5154
let?: Document;
52-
/** Return the raw result document instead of the ModifyResult */
55+
/**
56+
* Return the ModifyResult instead of the modified document. Defaults to true
57+
* but will default to false in the next major version.
58+
*/
5359
includeResultMetadata?: boolean;
5460
}
5561

@@ -71,7 +77,10 @@ export interface FindOneAndUpdateOptions extends CommandOperationOptions {
7177
upsert?: boolean;
7278
/** Map of parameter names and values that can be accessed using $$var (requires MongoDB 5.0). */
7379
let?: Document;
74-
/** Return the raw result document instead of the ModifyResult */
80+
/**
81+
* Return the ModifyResult instead of the modified document. Defaults to true
82+
* but will default to false in the next major version.
83+
*/
7584
includeResultMetadata?: boolean;
7685
}
7786

0 commit comments

Comments
 (0)