fix(index.d.ts): make SchemaTypeOptions a class, add missing `SchemaT…

…ype#OptionsConstructor` Fix #10001
Automattic · Mar 18, 2021 · 7edde3f · 7edde3f
1 parent 12767f9
commit 7edde3f
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -1380,7 +1380,7 @@ declare module 'mongoose' {
 
   type Unpacked<T> = T extends (infer U)[] ? U : T;
 
-  interface SchemaTypeOptions<T> {
+  export class SchemaTypeOptions<T> {
     type?:
       T extends string | number | Function ? SchemaDefinitionWithBuiltInClass<T> :
       T extends Schema<any> ? T :
@@ -2536,6 +2536,9 @@ declare module 'mongoose' {
     /** Attaches a getter for all instances of this schema type. */
     static get(getter: (value: any) => any): void;
 
+    /** The class that Mongoose uses internally to instantiate this SchemaType's `options` property. */
+    OptionsConstructor: typeof SchemaTypeOptions;
+
     /** Cast `val` to this schema type. Each class that inherits from schema type should implement this function. */
     cast(val: any, doc: Document<any>, init: boolean): any;
 

diff --git a/lib/schematype.js b/lib/schematype.js
@@ -119,7 +119,7 @@ function SchemaType(path, options, instance) {
 }
 
 /*!
- * ignore
+ * The class that Mongoose uses internally to instantiate this SchemaType's `options` property.
  */
 
 SchemaType.prototype.OptionsConstructor = SchemaTypeOptions;