Merge pull request #12258 from hasezoey/addTypesModelRemove

fix(types): add parameter "options" to "Model.remove"
Automattic · Aug 22, 2022 · ca5cc2c · ca5cc2c
2 parents 1284e68 + 3a14bef
commit ca5cc2c
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/test/types/models.test.ts b/test/types/models.test.ts
@@ -447,6 +447,12 @@ function gh12100() {
 })();
 
 
+function modelRemoveOptions() {
+  const cmodel = model('Test', new Schema());
+
+  cmodel.remove({}, {});
+}
+
 async function gh12286() {
   interface IUser{
     name: string;

diff --git a/types/models.d.ts b/types/models.d.ts
@@ -113,6 +113,8 @@ declare module 'mongoose' {
     wtimeout?: number;
   }
 
+  interface RemoveOptions extends SessionOption, Omit<mongodb.DeleteOptions, 'session'> {}
+
   const Model: Model<any>;
   interface Model<T, TQueryHelpers = {}, TMethodsAndOverrides = {}, TVirtuals = {}, TSchema = any> extends
     NodeJS.EventEmitter,
@@ -392,6 +394,7 @@ declare module 'mongoose' {
     ): Promise<any>;
 
     remove<ResultDoc = HydratedDocument<T, TMethodsAndOverrides, TVirtuals>>(filter?: any, callback?: CallbackWithoutResult): QueryWithHelpers<any, ResultDoc, TQueryHelpers, T>;
+    remove<ResultDoc = HydratedDocument<T, TMethodsAndOverrides, TVirtuals>>(filter?: any, options?: RemoveOptions, callback?: CallbackWithoutResult): QueryWithHelpers<any, ResultDoc, TQueryHelpers, T>;
 
     /** Creates a `replaceOne` query: finds the first document that matches `filter` and replaces it with `replacement`. */
     replaceOne<ResultDoc = HydratedDocument<T, TMethodsAndOverrides, TVirtuals>>(