add TypeScript types, jsdoc, and options support for Model.listSearch…

…Indexes()
Automattic · Apr 16, 2024 · ec518ed · ec518ed
1 parent 6605629
commit ec518ed
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 2 deletions.
diff --git a/lib/model.js b/lib/model.js
@@ -1655,11 +1655,27 @@ Model.dropSearchIndex = async function dropSearchIndex(name) {
   return await this.$__collection.dropSearchIndex(name);
 };
 
+/**
+ * List all [Atlas search indexes](https://www.mongodb.com/docs/atlas/atlas-search/create-index/) on this model's collection.
+ * This function only works when connected to MongoDB Atlas.
+ *
+ * #### Example:
+ *
+ *     const schema = new Schema({ name: { type: String, unique: true } });
+ *     const Customer = mongoose.model('Customer', schema);
+ *
+ *     await Customer.createSearchIndex({ name: 'test', definition: { mappings: { dynamic: true } } });
+ *     const res = await Customer.listSearchIndexes(); // Includes `[{ name: 'test' }]`
+ *
+ * @param {Object} [options]
+ * @return {Promise<Array>}
+ * @api public
+ */
 
-Model.listSearchIndexes = async function listSearchIndexes() {
+Model.listSearchIndexes = async function listSearchIndexes(options) {
   _checkContext(this, 'listSearchIndexes');
 
-  const cursor = await this.$__collection.listSearchIndexes();
+  const cursor = await this.$__collection.listSearchIndexes(options);
 
   return await cursor.toArray();
 };

diff --git a/types/models.d.ts b/types/models.d.ts
@@ -544,6 +544,12 @@ declare module 'mongoose' {
       Array<MergeType<THydratedDocumentType, Omit<DocContents, '_id'>>>
     >;
 
+    /**
+     * List all [Atlas search indexes](https://www.mongodb.com/docs/atlas/atlas-search/create-index/) on this model's collection.
+     * This function only works when connected to MongoDB Atlas.
+     */
+    listSearchIndexes(options?: mongodb.ListSearchIndexesOptions): Promise<Array<{ name: string }>>;
+
     /** The name of the model */
     modelName: string;