types: add cleanIndexes() to IndexManager interface

Automattic · Dec 24, 2024 · d9c7051 · d9c7051
1 parent 682160f
commit d9c7051
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/types/indexes.d.ts b/types/indexes.d.ts
@@ -10,6 +10,9 @@ declare module 'mongoose' {
   function syncIndexes(options?: SyncIndexesOptions): Promise<ConnectionSyncIndexesResult>;
 
   interface IndexManager {
+    /* Deletes all indexes that aren't defined in this model's schema. Used by `syncIndexes()`. */
+    cleanIndexes(options?: { toDrop?: string[], hideIndexes?: boolean }): Promise<string[]>;
+
     /**
      * Similar to `ensureIndexes()`, except for it uses the [`createIndex`](https://mongodb.github.io/node-mongodb-native/4.9/classes/Collection.html#createIndex)
      * function.