@@ -43,7 +43,10 @@ export interface ClientInsertOneModel<TSchema extends Document = Document>
43
43
export interface ClientDeleteOneModel < TSchema extends Document = Document >
44
44
extends ClientWriteModel {
45
45
name : 'deleteOne' ;
46
- /** The filter to limit the deleted documents. */
46
+ /**
47
+ * The filter used to determine if a document should be deleted.
48
+ * For a deleteOne operation, the first match is removed.
49
+ */
47
50
filter : Filter < TSchema > ;
48
51
/** Specifies a collation. */
49
52
collation ?: CollationOptions ;
@@ -55,7 +58,10 @@ export interface ClientDeleteOneModel<TSchema extends Document = Document>
55
58
export interface ClientDeleteManyModel < TSchema extends Document = Document >
56
59
extends ClientWriteModel {
57
60
name : 'deleteMany' ;
58
- /** The filter to limit the deleted documents. */
61
+ /**
62
+ * The filter used to determine if a document should be deleted.
63
+ * For a deleteOne operation, all matches are removed.
64
+ */
59
65
filter : Filter < TSchema > ;
60
66
/** Specifies a collation. */
61
67
collation ?: CollationOptions ;
@@ -67,7 +73,10 @@ export interface ClientDeleteManyModel<TSchema extends Document = Document>
67
73
export interface ClientReplaceOneModel < TSchema extends Document = Document >
68
74
extends ClientWriteModel {
69
75
name : 'replaceOne' ;
70
- /** The filter to limit the replaced document. */
76
+ /**
77
+ * The filter used to determine if a document should be replaced.
78
+ * For a replaceOne operation, the first match is replaced.
79
+ */
71
80
filter : Filter < TSchema > ;
72
81
/** The document with which to replace the matched document. */
73
82
replacement : WithoutId < TSchema > ;
@@ -83,7 +92,10 @@ export interface ClientReplaceOneModel<TSchema extends Document = Document>
83
92
export interface ClientUpdateOneModel < TSchema extends Document = Document >
84
93
extends ClientWriteModel {
85
94
name : 'updateOne' ;
86
- /** The filter to limit the updated documents. */
95
+ /**
96
+ * The filter used to determine if a document should be updated.
97
+ * For an updateOne operation, the first match is updated.
98
+ */
87
99
filter : Filter < TSchema > ;
88
100
/**
89
101
* The modifications to apply. The value can be either:
@@ -105,7 +117,10 @@ export interface ClientUpdateOneModel<TSchema extends Document = Document>
105
117
export interface ClientUpdateManyModel < TSchema extends Document = Document >
106
118
extends ClientWriteModel {
107
119
name : 'updateMany' ;
108
- /** The filter to limit the updated documents. */
120
+ /**
121
+ * The filter used to determine if a document should be updated.
122
+ * For an updateMany operation, all matches are updated.
123
+ */
109
124
filter : Filter < TSchema > ;
110
125
/**
111
126
* The modifications to apply. The value can be either:
0 commit comments