Merge pull request #14464 from noseworthy/re-export-search-index-desc…

…ription types(schema): re-export the defintion for `SearchIndexDescription`
Automattic · Mar 26, 2024 · f3a094f · f3a094f
2 parents 7f2c56c + 55fde0e
commit f3a094f
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 2 deletions.
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -279,7 +279,7 @@ declare module 'mongoose' {
      *
      * @remarks Search indexes are only supported when used against a 7.0+ Mongo Atlas cluster.
      */
-    searchIndex(description: mongodb.SearchIndexDescription): this;
+    searchIndex(description: SearchIndexDescription): this;
 
     /**
      * Returns a list of indexes that this schema declares, via `schema.index()`

diff --git a/types/indexes.d.ts b/types/indexes.d.ts
@@ -86,4 +86,6 @@ declare module 'mongoose' {
     expires?: number | string;
     weights?: Record<string, number>;
   }
+
+  type SearchIndexDescription = mongodb.SearchIndexDescription;
 }
diff --git a/types/models.d.ts b/types/models.d.ts
@@ -327,7 +327,7 @@ declare module 'mongoose' {
      * Create an [Atlas search index](https://www.mongodb.com/docs/atlas/atlas-search/create-index/).
      * This function only works when connected to MongoDB Atlas.
      */
-    createSearchIndex(description: mongodb.SearchIndexDescription): Promise<string>;
+    createSearchIndex(description: SearchIndexDescription): Promise<string>;
 
     /** Connection the model uses. */
     db: Connection;