Merge pull request #12167 from emiljanitzek/feature/bulk-write-types

fix(types): pass type to mongodb bulk write operation
Automattic · Aug 3, 2022 · aabf3b2 · aabf3b2
2 parents 67c2e93 + 6b24fa0
commit aabf3b2
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 3 deletions.
diff --git a/test/types/models.test.ts b/test/types/models.test.ts
@@ -282,6 +282,33 @@ function bulkWrite() {
   M.bulkWrite(ops);
 }
 
+function bulkWriteAddToSet() {
+  const schema = new Schema({
+    arr: [String]
+  });
+
+  const M = model('Test', schema);
+
+  const ops = [
+    {
+      updateOne: {
+        filter: {
+          arr: {
+            $nin: ['abc']
+          }
+        },
+        update: {
+          $addToSet: {
+            arr: 'abc'
+          }
+        }
+      }
+    }
+  ];
+
+  return M.bulkWrite(ops);
+}
+
 export function autoTypedModel() {
   const AutoTypedSchema = autoTypedSchema();
   const AutoTypedModel = model('AutoTypeModel', AutoTypedSchema);

diff --git a/types/models.d.ts b/types/models.d.ts
@@ -144,9 +144,9 @@ declare module 'mongoose' {
      * if you use `create()`) because with `bulkWrite()` there is only one network
      * round trip to the MongoDB server.
      */
-    bulkWrite(writes: Array<mongodb.AnyBulkWriteOperation>, options: mongodb.BulkWriteOptions & MongooseBulkWriteOptions, callback: Callback<mongodb.BulkWriteResult>): void;
-    bulkWrite(writes: Array<mongodb.AnyBulkWriteOperation>, callback: Callback<mongodb.BulkWriteResult>): void;
-    bulkWrite(writes: Array<mongodb.AnyBulkWriteOperation>, options?: mongodb.BulkWriteOptions & MongooseBulkWriteOptions): Promise<mongodb.BulkWriteResult>;
+    bulkWrite(writes: Array<mongodb.AnyBulkWriteOperation<T>>, options: mongodb.BulkWriteOptions & MongooseBulkWriteOptions, callback: Callback<mongodb.BulkWriteResult>): void;
+    bulkWrite(writes: Array<mongodb.AnyBulkWriteOperation<T>>, callback: Callback<mongodb.BulkWriteResult>): void;
+    bulkWrite(writes: Array<mongodb.AnyBulkWriteOperation<T>>, options?: mongodb.BulkWriteOptions & MongooseBulkWriteOptions): Promise<mongodb.BulkWriteResult>;
 
     /**
      * Sends multiple `save()` calls in a single `bulkWrite()`. This is faster than