Merge pull request #13718 from Automattic/vkarpov15/gh-13702

types(schema): correct return type for `Schema.prototype.indexes()`
Automattic · Aug 10, 2023 · a88b73f · a88b73f
2 parents 35d0978 + 56dfead
commit a88b73f
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 9 deletions.
diff --git a/test/types/schema.test.ts b/test/types/schema.test.ts
@@ -1,19 +1,21 @@
 import {
   Schema,
   Document,
+  HydratedDocument,
+  IndexDefinition,
+  IndexOptions,
+  InferSchemaType,
+  InsertManyOptions,
+  ObtainDocumentType,
+  ObtainSchemaGeneric,
+  ResolveSchemaOptions,
   SchemaDefinition,
   SchemaTypeOptions,
   Model,
-  Types,
-  InferSchemaType,
   SchemaType,
+  Types,
   Query,
-  model,
-  HydratedDocument,
-  ResolveSchemaOptions,
-  ObtainDocumentType,
-  ObtainSchemaGeneric,
-  InsertManyOptions
+  model
 } from 'mongoose';
 import { expectType, expectError, expectAssignable } from 'tsd';
 import { ObtainDocumentPathType, ResolvePathType } from '../../types/inferschematype';
@@ -1170,3 +1172,8 @@ function gh13633() {
     expectType<(InsertManyOptions & { lean?: boolean }) | undefined>(options);
   });
 }
+
+function gh13702() {
+  const schema = new Schema({ name: String });
+  expectType<[IndexDefinition, IndexOptions][]>(schema.indexes());
+}
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -278,7 +278,7 @@ declare module 'mongoose' {
      * Returns a list of indexes that this schema declares, via `schema.index()`
      * or by `index: true` in a path's options.
      */
-    indexes(): Array<IndexDefinition>;
+    indexes(): Array<[IndexDefinition, IndexOptions]>;
 
     /** Gets a schema option. */
     get<K extends keyof SchemaOptions>(key: K): SchemaOptions[K];