Skip to content

Commit b4aa2bd

Browse files
committed
docs(NODE-4263): document initialize bulk op function require connection
1 parent 0ea43c6 commit b4aa2bd

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

src/collection.ts

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1544,12 +1544,22 @@ export class Collection<TSchema extends Document = Document> {
15441544
);
15451545
}
15461546

1547-
/** Initiate an Out of order batch write operation. All operations will be buffered into insert/update/remove commands executed out of order. */
1547+
/**
1548+
* Initiate an Out of order batch write operation. All operations will be buffered into insert/update/remove commands executed out of order.
1549+
*
1550+
* @remarks
1551+
* **NOTE:** MongoClient must be connected prior to calling this API.
1552+
*/
15481553
initializeUnorderedBulkOp(options?: BulkWriteOptions): UnorderedBulkOperation {
15491554
return new UnorderedBulkOperation(this as TODO_NODE_3286, resolveOptions(this, options));
15501555
}
15511556

1552-
/** Initiate an In order bulk write operation. Operations will be serially executed in the order they are added, creating a new operation for each switch in types. */
1557+
/**
1558+
* Initiate an In order bulk write operation. Operations will be serially executed in the order they are added, creating a new operation for each switch in types.
1559+
*
1560+
* @remarks
1561+
* **NOTE:** MongoClient must be connected prior to calling this API.
1562+
*/
15531563
initializeOrderedBulkOp(options?: BulkWriteOptions): OrderedBulkOperation {
15541564
return new OrderedBulkOperation(this as TODO_NODE_3286, resolveOptions(this, options));
15551565
}

0 commit comments

Comments
 (0)