mongoose 6.2.5 → 6.2.8

package/types/index.d.ts

@@ -1,13 +1,14 @@
 /// <reference path="./connection.d.ts" />
-/// <reference path="./cursor.ts" />
+/// <reference path="./cursor.d.ts" />
+/// <reference path="./document.d.ts" />
 /// <reference path="./error.d.ts" />
+/// <reference path="./mongooseoptions.d.ts" />
 /// <reference path="./pipelinestage.d.ts" />
 /// <reference path="./schemaoptions.d.ts" />
 
 import events = require('events');
 import mongodb = require('mongodb');
 import mongoose = require('mongoose');
-import stream = require('stream');
 
 declare module 'mongoose' {
 
@@ -174,117 +175,6 @@ declare module 'mongoose' {
 
   type Mongoose = typeof mongoose;
 
-  interface MongooseOptions {
-    /** true by default. Set to false to skip applying global plugins to child schemas */
-    applyPluginsToChildSchemas?: boolean;
-
-    /**
-     * false by default. Set to true to apply global plugins to discriminator schemas.
-     * This typically isn't necessary because plugins are applied to the base schema and
-     * discriminators copy all middleware, methods, statics, and properties from the base schema.
-     */
-    applyPluginsToDiscriminators?: boolean;
-
-    /**
-     * Set to `true` to make Mongoose call` Model.createCollection()` automatically when you
-     * create a model with `mongoose.model()` or `conn.model()`. This is useful for testing
-     * transactions, change streams, and other features that require the collection to exist.
-     */
-    autoCreate?: boolean;
-
-    /**
-     * true by default. Set to false to disable automatic index creation
-     * for all models associated with this Mongoose instance.
-     */
-    autoIndex?: boolean;
-
-    /** enable/disable mongoose's buffering mechanism for all connections and models */
-    bufferCommands?: boolean;
-
-    bufferTimeoutMS?: number;
-
-    /** false by default. Set to `true` to `clone()` all schemas before compiling into a model. */
-    cloneSchemas?: boolean;
-
-    /**
-     * If `true`, prints the operations mongoose sends to MongoDB to the console.
-     * If a writable stream is passed, it will log to that stream, without colorization.
-     * If a callback function is passed, it will receive the collection name, the method
-     * name, then all arguments passed to the method. For example, if you wanted to
-     * replicate the default logging, you could output from the callback
-     * `Mongoose: ${collectionName}.${methodName}(${methodArgs.join(', ')})`.
-     */
-    debug?:
-      | boolean
-      | { color?: boolean; shell?: boolean }
-      | stream.Writable
-      | ((collectionName: string, methodName: string, ...methodArgs: any[]) => void);
-
-    /** If set, attaches [maxTimeMS](https://docs.mongodb.com/manual/reference/operator/meta/maxTimeMS/) to every query */
-    maxTimeMS?: number;
-
-    /**
-     * true by default. Mongoose adds a getter to MongoDB ObjectId's called `_id` that
-     * returns `this` for convenience with populate. Set this to false to remove the getter.
-     */
-    objectIdGetter?: boolean;
-
-    /**
-     * Set to `true` to default to overwriting models with the same name when calling
-     * `mongoose.model()`, as opposed to throwing an `OverwriteModelError`.
-     */
-    overwriteModels?: boolean;
-
-    /**
-     * If `false`, changes the default `returnOriginal` option to `findOneAndUpdate()`,
-     * `findByIdAndUpdate`, and `findOneAndReplace()` to false. This is equivalent to
-     * setting the `new` option to `true` for `findOneAndX()` calls by default. Read our
-     * `findOneAndUpdate()` [tutorial](https://mongoosejs.com/docs/tutorials/findoneandupdate.html)
-     * for more information.
-     */
-    returnOriginal?: boolean;
-
-    /**
-     * false by default. Set to true to enable [update validators](
-     * https://mongoosejs.com/docs/validation.html#update-validators
-     * ) for all validators by default.
-     */
-    runValidators?: boolean;
-
-    sanitizeFilter?: boolean;
-
-    sanitizeProjection?: boolean;
-
-    /**
-     * true by default. Set to false to opt out of Mongoose adding all fields that you `populate()`
-     * to your `select()`. The schema-level option `selectPopulatedPaths` overwrites this one.
-     */
-    selectPopulatedPaths?: boolean;
-
-    setDefaultsOnInsert?: boolean;
-
-    /** true by default, may be `false`, `true`, or `'throw'`. Sets the default strict mode for schemas. */
-    strict?: boolean | 'throw';
-
-    /** true by default. set to `false` to allow populating paths that aren't in the schema */
-    strictPopulate?: boolean;
-
-    /**
-     * false by default, may be `false`, `true`, or `'throw'`. Sets the default
-     * [strictQuery](https://mongoosejs.com/docs/guide.html#strictQuery) mode for schemas.
-     */
-    strictQuery?: boolean | 'throw';
-
-    /**
-     * `{ transform: true, flattenDecimals: true }` by default. Overwrites default objects to
-     * `toJSON()`, for determining how Mongoose documents get serialized by `JSON.stringify()`
-     */
-    toJSON?: ToObjectOptions;
-
-    /** `{ transform: true, flattenDecimals: true }` by default. Overwrites default objects to `toObject()` */
-    toObject?: ToObjectOptions;
-  }
-
   // eslint-disable-next-line @typescript-eslint/no-empty-interface
   interface ClientSession extends mongodb.ClientSession { }
 
@@ -331,247 +221,8 @@ declare module 'mongoose' {
     getIndexes(): any;
   }
 
-  class Document<T = any, TQueryHelpers = any, DocType = any> {
-    constructor(doc?: any);
-
-    /** This documents _id. */
-    _id?: T;
-
-    /** This documents __v. */
-    __v?: any;
-
-    /* Get all subdocs (by bfs) */
-    $getAllSubdocs(): Document[];
-
-    /** Don't run validation on this path or persist changes to this path. */
-    $ignore(path: string): void;
-
-    /** Checks if a path is set to its default. */
-    $isDefault(path: string): boolean;
-
-    /** Getter/setter, determines whether the document was removed or not. */
-    $isDeleted(val?: boolean): boolean;
-
-    /** Returns an array of all populated documents associated with the query */
-    $getPopulatedDocs(): Document[];
-
-    /**
-     * Returns true if the given path is nullish or only contains empty objects.
-     * Useful for determining whether this subdoc will get stripped out by the
-     * [minimize option](/docs/guide.html#minimize).
-     */
-    $isEmpty(path: string): boolean;
-
-    /** Checks if a path is invalid */
-    $isValid(path: string): boolean;
-
-    /**
-     * Empty object that you can use for storing properties on the document. This
-     * is handy for passing data to middleware without conflicting with Mongoose
-     * internals.
-     */
-    $locals: Record<string, unknown>;
-
-    /** Marks a path as valid, removing existing validation errors. */
-    $markValid(path: string): void;
-
-    /**
-     * A string containing the current operation that Mongoose is executing
-     * on this document. May be `null`, `'save'`, `'validate'`, or `'remove'`.
-     */
-    $op: string | null;
-
-    /**
-     * Getter/setter around the session associated with this document. Used to
-     * automatically set `session` if you `save()` a doc that you got from a
-     * query with an associated session.
-     */
-    $session(session?: mongodb.ClientSession | null): mongodb.ClientSession;
-
-    /** Alias for `set()`, used internally to avoid conflicts */
-    $set(path: string, val: any, options?: any): this;
-    $set(path: string, val: any, type: any, options?: any): this;
-    $set(value: any): this;
-
-    /** Set this property to add additional query filters when Mongoose saves this document and `isNew` is false. */
-    $where: Record<string, unknown>;
-
-    /** If this is a discriminator model, `baseModelName` is the name of the base model. */
-    baseModelName?: string;
-
-    /** Collection the model uses. */
-    collection: Collection;
-
-    /** Connection the model uses. */
-    db: Connection;
-
-    /** Removes this document from the db. */
-    delete(options?: QueryOptions): QueryWithHelpers<any, this, TQueryHelpers>;
-    delete(options: QueryOptions, cb?: Callback): void;
-    delete(cb: Callback): void;
-
-    /** Removes this document from the db. */
-    deleteOne(options?: QueryOptions): QueryWithHelpers<any, this, TQueryHelpers>;
-    deleteOne(options: QueryOptions, cb?: Callback): void;
-    deleteOne(cb: Callback): void;
-
-    /**
-     * Takes a populated field and returns it to its unpopulated state. If called with
-     * no arguments, then all populated fields are returned to their unpopulated state.
-     */
-    depopulate(path?: string | string[]): this;
-
-    /**
-     * Returns the list of paths that have been directly modified. A direct
-     * modified path is a path that you explicitly set, whether via `doc.foo = 'bar'`,
-     * `Object.assign(doc, { foo: 'bar' })`, or `doc.set('foo', 'bar')`.
-     */
-    directModifiedPaths(): Array<string>;
-
-    /**
-     * Returns true if this document is equal to another document.
-     *
-     * Documents are considered equal when they have matching `_id`s, unless neither
-     * document has an `_id`, in which case this function falls back to using
-     * `deepEqual()`.
-     */
-    equals(doc: Document<T>): boolean;
-
-    /** Hash containing current validation errors. */
-    errors?: Error.ValidationError;
-
-    /** Returns the value of a path. */
-    get(path: string, type?: any, options?: any): any;
-
-    /**
-     * Returns the changes that happened to the document
-     * in the format that will be sent to MongoDB.
-     */
-    getChanges(): UpdateQuery<this>;
-
-    /** The string version of this documents _id. */
-    id?: any;
-
-    /** Signal that we desire an increment of this documents version. */
-    increment(): this;
-
-    /**
-     * Initializes the document without setters or marking anything modified.
-     * Called internally after a document is returned from mongodb. Normally,
-     * you do **not** need to call this function on your own.
-     */
-    init(obj: any, opts?: any, cb?: Callback<this>): this;
-
-    /** Marks a path as invalid, causing validation to fail. */
-    invalidate(path: string, errorMsg: string | NativeError, value?: any, kind?: string): NativeError | null;
-
-    /** Returns true if `path` was directly set and modified, else false. */
-    isDirectModified(path: string): boolean;
-
-    /** Checks if `path` was explicitly selected. If no projection, always returns true. */
-    isDirectSelected(path: string): boolean;
-
-    /** Checks if `path` is in the `init` state, that is, it was set by `Document#init()` and not modified since. */
-    isInit(path: string): boolean;
-
-    /**
-     * Returns true if any of the given paths is modified, else false. If no arguments, returns `true` if any path
-     * in this document is modified.
-     */
-    isModified(path?: string | Array<string>): boolean;
-
-    /** Boolean flag specifying if the document is new. */
-    isNew: boolean;
-
-    /** Checks if `path` was selected in the source query which initialized this document. */
-    isSelected(path: string): boolean;
-
-    /** Marks the path as having pending changes to write to the db. */
-    markModified(path: string, scope?: any): void;
-
-    /** Returns the list of paths that have been modified. */
-    modifiedPaths(options?: { includeChildren?: boolean }): Array<string>;
-
-    /** The name of the model */
-    modelName: string;
-
-    /**
-     * Overwrite all values in this document with the values of `obj`, except
-     * for immutable properties. Behaves similarly to `set()`, except for it
-     * unsets all properties that aren't in `obj`.
-     */
-    overwrite(obj: AnyObject): this;
-
-    /**
-     * If this document is a subdocument or populated document, returns the
-     * document's parent. Returns undefined otherwise.
-     */
-    $parent(): Document | undefined;
-
-    /** Populates document references. */
-    populate<Paths = {}>(path: string | PopulateOptions | (string | PopulateOptions)[]): Promise<this & Paths>;
-    populate<Paths = {}>(path: string | PopulateOptions | (string | PopulateOptions)[], callback: Callback<this & Paths>): void;
-    populate<Paths = {}>(path: string, names: string): Promise<this & Paths>;
-    populate<Paths = {}>(path: string, names: string, callback: Callback<this & Paths>): void;
-
-    /** Gets _id(s) used during population of the given `path`. If the path was not populated, returns `undefined`. */
-    populated(path: string): any;
-
-    /** Removes this document from the db. */
-    remove(options?: QueryOptions): Promise<this>;
-    remove(options?: QueryOptions, cb?: Callback): void;
-
-    /** Sends a replaceOne command with this document `_id` as the query selector. */
-    replaceOne(replacement?: AnyObject, options?: QueryOptions | null, callback?: Callback): Query<any, this>;
-    replaceOne(replacement?: AnyObject, options?: QueryOptions | null, callback?: Callback): Query<any, this>;
-
-    /** Saves this document by inserting a new document into the database if [document.isNew](/docs/api.html#document_Document-isNew) is `true`, or sends an [updateOne](/docs/api.html#document_Document-updateOne) operation with just the modified paths if `isNew` is `false`. */
-    save(options?: SaveOptions): Promise<this>;
-    save(options?: SaveOptions, fn?: Callback<this>): void;
-    save(fn?: Callback<this>): void;
-
-    /** The document's schema. */
-    schema: Schema;
-
-    /** Sets the value of a path, or many paths. */
-    set(path: string, val: any, options?: any): this;
-    set(path: string, val: any, type: any, options?: any): this;
-    set(value: any): this;
-
-    /** The return value of this method is used in calls to JSON.stringify(doc). */
-    toJSON(options: ToObjectOptions & { flattenMaps: false }): LeanDocument<this>;
-    toJSON(options?: ToObjectOptions): FlattenMaps<LeanDocument<this>>;
-    toJSON<T = FlattenMaps<DocType>>(options?: ToObjectOptions): T;
-
-    /** Converts this document into a plain-old JavaScript object ([POJO](https://masteringjs.io/tutorials/fundamentals/pojo)). */
-    toObject(options?: ToObjectOptions): LeanDocument<this>;
-    toObject<T = DocType>(options?: ToObjectOptions): T;
-
-    /** Clears the modified state on the specified path. */
-    unmarkModified(path: string): void;
-
-    /** Sends an update command with this document `_id` as the query selector. */
-    update(update?: UpdateQuery<this> | UpdateWithAggregationPipeline, options?: QueryOptions | null, callback?: Callback): Query<any, this>;
-
-    /** Sends an updateOne command with this document `_id` as the query selector. */
-    updateOne(update?: UpdateQuery<this> | UpdateWithAggregationPipeline, options?: QueryOptions | null, callback?: Callback): Query<any, this>;
-
-    /** Executes registered validation rules for this document. */
-    validate(options:{ pathsToSkip?: pathsToSkip }): Promise<void>;
-    validate(pathsToValidate?: pathsToValidate, options?: any): Promise<void>;
-    validate(callback: CallbackWithoutResult): void;
-    validate(pathsToValidate: pathsToValidate, callback: CallbackWithoutResult): void;
-    validate(pathsToValidate: pathsToValidate, options: any, callback: CallbackWithoutResult): void;
-
-    /** Executes registered validation rules (skipping asynchronous validators) for this document. */
-    validateSync(options:{pathsToSkip?: pathsToSkip, [k:string]: any }): Error.ValidationError | null;
-    validateSync(pathsToValidate?: Array<string>, options?: any): Error.ValidationError | null;
-  }
-
   /** A list of paths to validate. If set, Mongoose will validate only the modified paths that are in the given list. */
   type pathsToValidate = string[] | string;
-  /** A list of paths to skip. If set, Mongoose will validate every modified path that is not in this list. */
-  type pathsToSkip = string[] | string;
 
   interface AcceptsDiscriminator {
     /** Adds a discriminator type. */
@@ -659,8 +310,8 @@ declare module 'mongoose' {
      * mongoose will not create the collection for the model until any documents are
      * created. Use this method to create the collection explicitly.
      */
-    createCollection<T>(options?: mongodb.CreateCollectionOptions): Promise<mongodb.Collection<T>>;
-    createCollection<T>(options: mongodb.CreateCollectionOptions | null, callback: Callback<mongodb.Collection<T>>): void;
+    createCollection<T>(options?: mongodb.CreateCollectionOptions & Pick<SchemaOptions, 'expires'>): Promise<mongodb.Collection<T>>;
+    createCollection<T>(options: mongodb.CreateCollectionOptions & Pick<SchemaOptions, 'expires'> | null, callback: Callback<mongodb.Collection<T>>): void;
 
     /**
      * Similar to `ensureIndexes()`, except for it uses the [`createIndex`](http://mongodb.github.io/node-mongodb-native/2.2/api/Collection.html#createIndex)
@@ -1058,6 +709,8 @@ declare module 'mongoose' {
     model?: string | Model<any>;
     /** optional query options like sort, limit, etc */
     options?: any;
+    /** optional boolean, set to `false` to allow populating paths that aren't in the schema */
+    strictPopulate?: boolean;
     /** deep populate */
     populate?: string | PopulateOptions | (string | PopulateOptions)[];
     /**
@@ -1101,12 +754,12 @@ declare module 'mongoose' {
   type IndexDirection = 1 | -1 | '2d' | '2dsphere' | 'geoHaystack' | 'hashed' | 'text';
   type IndexDefinition = Record<string, IndexDirection>;
 
-  type PreMiddlewareFunction<T> = (this: T, next: (err?: CallbackError) => void) => void | Promise<void>;
-  type PreSaveMiddlewareFunction<T> = (this: T, next: (err?: CallbackError) => void, opts: SaveOptions) => void | Promise<void>;
-  type PostMiddlewareFunction<ThisType, ResType = any> = (this: ThisType, res: ResType, next: (err?: CallbackError) => void) => void | Promise<void>;
-  type ErrorHandlingMiddlewareFunction<ThisType, ResType = any> = (this: ThisType, err: NativeError, res: ResType, next: (err?: CallbackError) => void) => void;
+  export type PreMiddlewareFunction<ThisType = any> = (this: ThisType, next: CallbackWithoutResultAndOptionalError) => void | Promise<void>;
+  export type PreSaveMiddlewareFunction<ThisType = any> = (this: ThisType, next: CallbackWithoutResultAndOptionalError, opts: SaveOptions) => void | Promise<void>;
+  export type PostMiddlewareFunction<ThisType = any, ResType = any> = (this: ThisType, res: ResType, next: CallbackWithoutResultAndOptionalError) => void | Promise<void>;
+  export type ErrorHandlingMiddlewareFunction<ThisType = any, ResType = any> = (this: ThisType, err: NativeError, res: ResType, next: CallbackWithoutResultAndOptionalError) => void;
 
-  class Schema<DocType = any, M = Model<DocType, any, any, any>, TInstanceMethods = any, TQueryHelpers = any> extends events.EventEmitter {
+  class Schema<DocType = any, M = Model<DocType, any, any, any>, TInstanceMethods = {}, TQueryHelpers = {}> extends events.EventEmitter {
     /**
      * Create a new schema
      */
@@ -1160,7 +813,7 @@ declare module 'mongoose' {
     method(obj: Partial<TInstanceMethods>): this;
 
     /** Object of currently defined methods on this schema. */
-    methods: { [F in keyof TInstanceMethods]: TInstanceMethods[F] };
+    methods: { [F in keyof TInstanceMethods]: TInstanceMethods[F] } & AnyObject;
 
     /** The original object passed to the schema constructor */
     obj: SchemaDefinition<SchemaDefinitionType<DocType>>;
@@ -1282,6 +935,8 @@ declare module 'mongoose' {
   type AnyArray<T> = T[] | ReadonlyArray<T>;
   type SchemaValidator<T> = RegExp | [RegExp, string] | Function | [Function, string] | ValidateOpts<T> | ValidateOpts<T>[];
 
+  type ExtractMongooseArray<T> = T extends Types.Array<any> ? AnyArray<Unpacked<T>> : T;
+
   export class SchemaTypeOptions<T> {
     type?:
       T extends string ? StringSchemaDefinition :
@@ -1319,7 +974,7 @@ declare module 'mongoose' {
      * The default value for this path. If a function, Mongoose executes the function
      * and uses the return value as the default.
      */
-    default?: T | ((this: any, doc: any) => Partial<T>);
+    default?: ExtractMongooseArray<T> | ((this: any, doc: any) => Partial<ExtractMongooseArray<T>>);
 
     /**
      * The model that `populate()` should use if populating this path.
@@ -1814,8 +1469,11 @@ declare module 'mongoose' {
 
   type QueryWithHelpers<ResultType, DocType, THelpers = {}, RawDocType = DocType> = Query<ResultType, DocType, THelpers, RawDocType> & THelpers;
 
-  type UnpackedIntersection<T, U> = T extends (infer V)[] ? (V & U)[] : T & U;
-  type UnpackedIntersectionWithNull<T, U> = T extends null ? UnpackedIntersection<T, U> | null : UnpackedIntersection<T, U>;
+  type UnpackedIntersection<T, U> = T extends (infer A)[]
+    ? (Omit<A, keyof U> & U)[]
+    : keyof U extends never
+    ? T
+  : Omit<T, keyof U> & U;
 
   type ProjectionFields<DocType> = {[Key in keyof Omit<LeanDocument<DocType>, '__v'>]?: any} & Record<string, any>;
 
@@ -2116,8 +1774,8 @@ declare module 'mongoose' {
     polygon(path: string, ...coordinatePairs: number[][]): this;
 
     /** Specifies paths which should be populated with other documents. */
-    populate<Paths = {}>(path: string, select?: string | any, model?: string | Model<any, THelpers>, match?: any): QueryWithHelpers<UnpackedIntersectionWithNull<ResultType, Paths>, DocType, THelpers, RawDocType>;
-    populate<Paths = {}>(options: PopulateOptions | Array<PopulateOptions>): QueryWithHelpers<UnpackedIntersectionWithNull<ResultType, Paths>, DocType, THelpers, RawDocType>;
+    populate<Paths = {}>(path: string | string[], select?: string | any, model?: string | Model<any, THelpers>, match?: any): QueryWithHelpers<UnpackedIntersection<ResultType, Paths>, DocType, THelpers, RawDocType>;
+    populate<Paths = {}>(options: PopulateOptions | (PopulateOptions | string)[]): QueryWithHelpers<UnpackedIntersection<ResultType, Paths>, DocType, THelpers, RawDocType>;
 
     /** Get/set the current projection (AKA fields). Pass `null` to remove the current projection. */
     projection(): ProjectionFields<DocType> | null;
@@ -2704,6 +2362,7 @@ declare module 'mongoose' {
   type Callback<T = any> = (error: CallbackError, result: T) => void;
 
   type CallbackWithoutResult = (error: CallbackError) => void;
+  type CallbackWithoutResultAndOptionalError = (error?: CallbackError) => void;
 
   /* for ts-mongoose */
   class mquery {}

package/types/mongooseoptions.d.ts

@@ -0,0 +1,180 @@
+import stream = require('stream');
+
+declare module 'mongoose' {
+
+  interface MongooseOptions {
+    /**
+     * Set to false to skip applying global plugins to child schemas.
+     *
+     * @default true
+     */
+    applyPluginsToChildSchemas?: boolean;
+
+    /**
+     * Set to true to apply global plugins to discriminator schemas.
+     * This typically isn't necessary because plugins are applied to the base schema and
+     * discriminators copy all middleware, methods, statics, and properties from the base schema.
+     *
+     * @default false
+     */
+    applyPluginsToDiscriminators?: boolean;
+
+    /**
+     * autoCreate is true by default unless readPreference is secondary or secondaryPreferred,
+     * which means Mongoose will attempt to create every model's underlying collection before
+     * creating indexes. If readPreference is secondary or secondaryPreferred, Mongoose will
+     * default to false for both autoCreate and autoIndex because both createCollection() and
+     * createIndex() will fail when connected to a secondary.
+     */
+    autoCreate?: boolean;
+
+    /**
+     * Set to false to disable automatic index creation for all models associated with this Mongoose instance.
+     *
+     * @default true
+     */
+    autoIndex?: boolean;
+
+    /**
+     * enable/disable mongoose's buffering mechanism for all connections and models.
+     *
+     * @default true
+     */
+    bufferCommands?: boolean;
+
+    /**
+     * If bufferCommands is on, this option sets the maximum amount of time Mongoose
+     * buffering will wait before throwing an error.
+     * If not specified, Mongoose will use 10000 (10 seconds).
+     *
+     * @default 10000
+     */
+    bufferTimeoutMS?: number;
+
+    /**
+     * Set to `true` to `clone()` all schemas before compiling into a model.
+     *
+     * @default false
+     */
+    cloneSchemas?: boolean;
+
+    /**
+     * If `true`, prints the operations mongoose sends to MongoDB to the console.
+     * If a writable stream is passed, it will log to that stream, without colorization.
+     * If a callback function is passed, it will receive the collection name, the method
+     * name, then all arguments passed to the method. For example, if you wanted to
+     * replicate the default logging, you could output from the callback
+     * `Mongoose: ${collectionName}.${methodName}(${methodArgs.join(', ')})`.
+     *
+     * @default false
+     */
+    debug?:
+    | boolean
+    | { color?: boolean; shell?: boolean; }
+    | stream.Writable
+    | ((collectionName: string, methodName: string, ...methodArgs: any[]) => void);
+
+    /** If set, attaches [maxTimeMS](https://docs.mongodb.com/manual/reference/operator/meta/maxTimeMS/) to every query */
+    maxTimeMS?: number;
+
+    /**
+     * Mongoose adds a getter to MongoDB ObjectId's called `_id` that
+     * returns `this` for convenience with populate. Set this to false to remove the getter.
+     *
+     * @default true
+     */
+    objectIdGetter?: boolean;
+
+    /**
+     * Set to `true` to default to overwriting models with the same name when calling
+     * `mongoose.model()`, as opposed to throwing an `OverwriteModelError`.
+     *
+     * @default false
+     */
+    overwriteModels?: boolean;
+
+    /**
+     * If `false`, changes the default `returnOriginal` option to `findOneAndUpdate()`,
+     * `findByIdAndUpdate`, and `findOneAndReplace()` to false. This is equivalent to
+     * setting the `new` option to `true` for `findOneAndX()` calls by default. Read our
+     * `findOneAndUpdate()` [tutorial](https://mongoosejs.com/docs/tutorials/findoneandupdate.html)
+     * for more information.
+     *
+     * @default true
+     */
+    returnOriginal?: boolean;
+
+    /**
+     * Set to true to enable [update validators](
+     * https://mongoosejs.com/docs/validation.html#update-validators
+     * ) for all validators by default.
+     *
+     * @default false
+     */
+    runValidators?: boolean;
+
+    /**
+     * Sanitizes query filters against [query selector injection attacks](
+     * https://thecodebarbarian.com/2014/09/04/defending-against-query-selector-injection-attacks.html
+     * ) by wrapping any nested objects that have a property whose name starts with $ in a $eq.
+     */
+    sanitizeFilter?: boolean;
+
+    sanitizeProjection?: boolean;
+
+    /**
+     * Set to false to opt out of Mongoose adding all fields that you `populate()`
+     * to your `select()`. The schema-level option `selectPopulatedPaths` overwrites this one.
+     *
+     * @default true
+     */
+    selectPopulatedPaths?: boolean;
+
+    /**
+     * Mongoose also sets defaults on update() and findOneAndUpdate() when the upsert option is
+     * set by adding your schema's defaults to a MongoDB $setOnInsert operator. You can disable
+     * this behavior by setting the setDefaultsOnInsert option to false.
+     *
+     * @default true
+     */
+    setDefaultsOnInsert?: boolean;
+
+    /**
+     * Sets the default strict mode for schemas.
+     * May be `false`, `true`, or `'throw'`.
+     *
+     * @default true
+     */
+    strict?: boolean | 'throw';
+
+    /**
+     * Set to `false` to allow populating paths that aren't in the schema.
+     *
+     * @default true
+     */
+    strictPopulate?: boolean;
+
+    /**
+     * Sets the default [strictQuery](https://mongoosejs.com/docs/guide.html#strictQuery) mode for schemas.
+     * May be `false`, `true`, or `'throw'`.
+     *
+     * @default false
+     */
+    strictQuery?: boolean | 'throw';
+
+    /**
+     * Overwrites default objects to `toJSON()`, for determining how Mongoose
+     * documents get serialized by `JSON.stringify()`
+     *
+     * @default { transform: true, flattenDecimals: true }
+     */
+    toJSON?: ToObjectOptions;
+
+    /**
+     * Overwrites default objects to `toObject()`
+     *
+     * @default { transform: true, flattenDecimals: true }
+     */
+    toObject?: ToObjectOptions;
+  }
+}

package/types/schemaoptions.d.ts

@@ -43,6 +43,12 @@ declare module 'mongoose' {
     /** The timeseries option to use when creating the model's collection. */
     timeseries?: mongodb.TimeSeriesCollectionOptions;
 
+    /** The number of seconds after which a document in a timeseries collection expires. */
+    expireAfterSeconds?: number;
+
+    /** The time after which a document in a timeseries collection expires. */
+    expires?: number | string;
+
     /**
      * Mongoose by default produces a collection name by passing the model name to the utils.toCollectionName
      * method. This method pluralizes the name. Set this option if you need a different name for your collection.