Hierarchy

Constructors

  • Type Parameters

    Parameters

    • Optional doc: DocType
    • Optional fields: any
    • Optional options: boolean | AnyObject

    Returns Document<unknown, {}, IUserDocument> & Omit<IUserDocument & {
        _id: ObjectId;
    }, never>

Properties

base: __module

Base Mongoose instance the model uses.

baseModelName: undefined | string

If this is a discriminator model, baseModelName is the name of the base model.

collection: Collection<Document>

Collection the model uses.

db: Connection

Connection the model uses.

discriminators: undefined | {
    [name: string]: Model<any>;
}

Registered discriminators for this model.

events: EventEmitter

Event emitter that reports any errors that occurred. Useful for global error handling.

modelName: string

The name of the model

schema: Schema<IUserDocument, Model<IUserDocument, any, any, any, Document<unknown, any, IUserDocument> & Omit<IUserDocument & {
    _id: ObjectId;
}, never>, any>, {}, {}, {}, {}, DefaultSchemaOptions, IUserDocument, Document<unknown, {}, FlatRecord<IUserDocument>> & Omit<FlatRecord<IUserDocument> & {
    _id: ObjectId;
}, never>>

Schema the model uses.

Methods

  • Alias for emitter.on(eventName, listener).

    Since

    v0.1.26

    Parameters

    • eventName: string | symbol
    • listener: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns IUserModel

  • Type Parameters

    • R = any

    Parameters

    • Optional pipeline: PipelineStage[]
    • Optional options: AggregateOptions

    Returns Aggregate<R[]>

  • Type Parameters

    • R = any

    Parameters

    • pipeline: PipelineStage[]

    Returns Aggregate<R[]>

  • Sends multiple save() calls in a single bulkWrite(). This is faster than sending multiple save() calls because with bulkSave() there is only one network round trip to the MongoDB server.

    Parameters

    • documents: Document<any, any, any>[]
    • Optional options: BulkWriteOptions & {
          timestamps?: boolean;
      }

    Returns Promise<BulkWriteResult>

  • Sends multiple insertOne, updateOne, updateMany, replaceOne, deleteOne, and/or deleteMany operations to the MongoDB server in one command. This is faster than sending multiple independent operations (e.g. if you use create()) because with bulkWrite() there is only one network round trip to the MongoDB server.

    Parameters

    • writes: AnyBulkWriteOperation<any>[]
    • Optional options: BulkWriteOptions & MongooseBulkWriteOptions

    Returns Promise<BulkWriteResult>

  • Cast the given POJO to the model's schema

    Parameters

    • obj: AnyObject
    • Optional options: {
          ignoreCastErrors?: boolean;
      }
      • Optional ignoreCastErrors?: boolean

    Returns IUserDocument

  • Creates a count query: counts the number of documents that match filter.

    Parameters

    Returns Query<number, Document<unknown, {}, IUserDocument> & Omit<IUserDocument & {
        _id: ObjectId;
    }, never>, {}, IUserDocument>

  • Creates a new document or documents

    Type Parameters

    Parameters

    • docs: (IUserDocument | DocContents)[]
    • Optional options: SaveOptions

    Returns Promise<(Document<unknown, {}, IUserDocument> & Omit<IUserDocument & {
        _id: ObjectId;
    }, never>)[]>

  • Type Parameters

    Parameters

    Returns Promise<Document<unknown, {}, IUserDocument> & Omit<IUserDocument & {
        _id: ObjectId;
    }, never>>

  • Type Parameters

    Parameters

    Returns Promise<(Document<unknown, {}, IUserDocument> & Omit<IUserDocument & {
        _id: ObjectId;
    }, never>)[]>

  • Create the collection for this model. By default, if no indexes are specified, mongoose will not create the collection for the model until any documents are created. Use this method to create the collection explicitly.

    Type Parameters

    • T extends Document

    Parameters

    • Optional options: CreateCollectionOptions & Pick<SchemaOptions<unknown, {}, {}, {}, {}, Document<unknown, {}, unknown> & Omit<{
          _id: ObjectId;
      }, never>>, "expires">

    Returns Promise<Collection<T>>

  • Similar to ensureIndexes(), except for it uses the createIndex function.

    Parameters

    • Optional options: CreateIndexesOptions

    Returns Promise<void>

  • Deletes all of the documents that match conditions from the collection. Behaves like remove(), but deletes all documents that match conditions regardless of the single option.

    Parameters

    Returns Query<DeleteResult, Document<unknown, {}, IUserDocument> & Omit<IUserDocument & {
        _id: ObjectId;
    }, never>, {}, IUserDocument>

  • Parameters

    Returns Query<DeleteResult, Document<unknown, {}, IUserDocument> & Omit<IUserDocument & {
        _id: ObjectId;
    }, never>, {}, IUserDocument>

  • Deletes the first document that matches conditions from the collection. Behaves like remove(), but deletes at most one document regardless of the single option.

    Parameters

    Returns Query<DeleteResult, Document<unknown, {}, IUserDocument> & Omit<IUserDocument & {
        _id: ObjectId;
    }, never>, {}, IUserDocument>

  • Parameters

    Returns Query<DeleteResult, Document<unknown, {}, IUserDocument> & Omit<IUserDocument & {
        _id: ObjectId;
    }, never>, {}, IUserDocument>

  • Does a dry-run of Model.syncIndexes(), meaning that the result of this function would be the result of Model.syncIndexes().

    Parameters

    • Optional options: Record<string, unknown>

    Returns Promise<IndexesDiff>

  • Adds a discriminator type.

    Type Parameters

    • D

    Parameters

    • name: string | number
    • schema: Schema<any, Model<any, any, any, any, any, any>, {}, {}, {}, {}, DefaultSchemaOptions, {}, Document<unknown, {}, FlatRecord<{}>> & Omit<FlatRecord<{}> & Required<{
          _id: unknown;
      }>, never>>
    • Optional value: string | number | ObjectId | DiscriminatorOptions

    Returns Model<D, {}, {}, {}, IfAny<D, any, Document<unknown, {}, D> & Omit<Require_id<D>, never>>, any>

  • Type Parameters

    • T

    • U

    Parameters

    • name: string | number
    • schema: Schema<T, U, {}, {}, {}, {}, DefaultSchemaOptions, ObtainDocumentType<any, T, DefaultSchemaOptions>, IfAny<FlatRecord<ObtainDocumentType<any, T, DefaultSchemaOptions>>, any, Document<unknown, {}, FlatRecord<ObtainDocumentType<any, T, DefaultSchemaOptions>>> & Omit<Require_id<FlatRecord<ObtainDocumentType<any, T, DefaultSchemaOptions>>>, never>>>
    • Optional value: string | number | ObjectId | DiscriminatorOptions

    Returns U

  • Creates a distinct query: returns the distinct values of the given field that match filter.

    Type Parameters

    • ReturnType = any

    Parameters

    Returns Query<ReturnType[], Document<unknown, {}, IUserDocument> & Omit<IUserDocument & {
        _id: ObjectId;
    }, never>, {}, IUserDocument>

  • Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments to each.

    Returns true if the event had listeners, false otherwise.

    const EventEmitter = require('events');
    const myEmitter = new EventEmitter();

    // First listener
    myEmitter.on('event', function firstListener() {
    console.log('Helloooo! first listener');
    });
    // Second listener
    myEmitter.on('event', function secondListener(arg1, arg2) {
    console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
    });
    // Third listener
    myEmitter.on('event', function thirdListener(...args) {
    const parameters = args.join(', ');
    console.log(`event with parameters ${parameters} in third listener`);
    });

    console.log(myEmitter.listeners('event'));

    myEmitter.emit('event', 1, 2, 3, 4, 5);

    // Prints:
    // [
    // [Function: firstListener],
    // [Function: secondListener],
    // [Function: thirdListener]
    // ]
    // Helloooo! first listener
    // event with parameters 1, 2 in second listener
    // event with parameters 1, 2, 3, 4, 5 in third listener

    Since

    v0.1.26

    Parameters

    • eventName: string | symbol
    • Rest ...args: any[]

    Returns boolean

  • Sends createIndex commands to mongo for each index declared in the schema. The createIndex commands are sent in series.

    Parameters

    • Optional options: CreateIndexesOptions

    Returns Promise<void>

  • Creates a estimatedDocumentCount query: counts the number of documents in the collection.

    Parameters

    Returns Query<number, Document<unknown, {}, IUserDocument> & Omit<IUserDocument & {
        _id: ObjectId;
    }, never>, {}, IUserDocument>

  • Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

    const EventEmitter = require('events');
    const myEE = new EventEmitter();
    myEE.on('foo', () => {});
    myEE.on('bar', () => {});

    const sym = Symbol('symbol');
    myEE.on(sym, () => {});

    console.log(myEE.eventNames());
    // Prints: [ 'foo', 'bar', Symbol(symbol) ]

    Since

    v6.0.0

    Returns (string | symbol)[]

  • Returns a document with its _id if at least one document exists in the database that matches the given filter, and null otherwise.

    Parameters

    Returns Query<null | {
        _id: any;
    }, Document<unknown, {}, IUserDocument> & Omit<IUserDocument & {
        _id: ObjectId;
    }, never>, {}, IUserDocument>

  • Parameters

    Returns Query<null | {
        _id: any;
    }, Document<unknown, {}, IUserDocument> & Omit<IUserDocument & {
        _id: ObjectId;
    }, never>, {}, IUserDocument>

  • Creates a find query: gets a list of documents that match filter.

    Type Parameters

    Parameters

    Returns Query<ResultDoc[], ResultDoc, {}, IUserDocument>

  • Type Parameters

    Parameters

    Returns Query<ResultDoc[], ResultDoc, {}, IUserDocument>

  • Type Parameters

    Parameters

    Returns Query<ResultDoc[], ResultDoc, {}, IUserDocument>

  • Type Parameters

    Returns Query<ResultDoc[], ResultDoc, {}, IUserDocument>

  • Finds a single document by its _id field. findById(id) is almost* equivalent to findOne({ _id: id }). If you want to query by a document's _id, use findById() instead of findOne().

    Type Parameters

    Parameters

    Returns Query<null | ResultDoc, ResultDoc, {}, IUserDocument>

  • Type Parameters

    Parameters

    • id: any
    • Optional projection: null | ProjectionType<IUserDocument>

    Returns Query<null | ResultDoc, ResultDoc, {}, IUserDocument>

  • Creates a findByIdAndDelete query, filtering by the given _id.

    Type Parameters

    Parameters

    • Optional id: any
    • Optional options: null | QueryOptions<IUserDocument>

    Returns Query<null | ResultDoc, ResultDoc, {}, IUserDocument>

  • Creates a findByIdAndRemove query, filtering by the given _id.

    Type Parameters

    Parameters

    • Optional id: any
    • Optional options: null | QueryOptions<IUserDocument>

    Returns Query<null | ResultDoc, ResultDoc, {}, IUserDocument>

  • Creates a findOneAndUpdate query, filtering by the given _id.

    Type Parameters

    Parameters

    Returns Query<ModifyResult<ResultDoc>, ResultDoc, {}, IUserDocument>

  • Type Parameters

    Parameters

    Returns Query<ResultDoc, ResultDoc, {}, IUserDocument>

  • Type Parameters

    Parameters

    Returns Query<null | ResultDoc, ResultDoc, {}, IUserDocument>

  • Type Parameters

    Parameters

    Returns Query<null | ResultDoc, ResultDoc, {}, IUserDocument>

  • Finds one document.

    Type Parameters

    Parameters

    Returns Query<null | ResultDoc, ResultDoc, {}, IUserDocument>

  • Type Parameters

    Parameters

    Returns Query<null | ResultDoc, ResultDoc, {}, IUserDocument>

  • Type Parameters

    Parameters

    Returns Query<null | ResultDoc, ResultDoc, {}, IUserDocument>

  • Creates a findOneAndDelete query: atomically finds the given document, deletes it, and returns the document as it was before deletion.

    Type Parameters

    Parameters

    Returns Query<null | ResultDoc, ResultDoc, {}, IUserDocument>

  • Creates a findOneAndRemove query: atomically finds the given document and deletes it.

    Type Parameters

    Parameters

    Returns Query<null | ResultDoc, ResultDoc, {}, IUserDocument>

  • Creates a findOneAndReplace query: atomically finds the given document and replaces it with replacement.

    Type Parameters

    Parameters

    Returns Query<ModifyResult<ResultDoc>, ResultDoc, {}, IUserDocument>

  • Type Parameters

    Parameters

    Returns Query<ResultDoc, ResultDoc, {}, IUserDocument>

  • Type Parameters

    Parameters

    Returns Query<null | ResultDoc, ResultDoc, {}, IUserDocument>

  • Creates a findOneAndUpdate query: atomically find the first document that matches filter and apply update.

    Type Parameters

    Parameters

    Returns Query<ModifyResult<ResultDoc>, ResultDoc, {}, IUserDocument>

  • Type Parameters

    Parameters

    Returns Query<ResultDoc, ResultDoc, {}, IUserDocument>

  • Type Parameters

    Parameters

    Returns Query<null | ResultDoc, ResultDoc, {}, IUserDocument>

  • Type Parameters

    Parameters

    • Optional filter: FilterQuery<IUserDocument>
    • Optional options: GeoSearchOptions

    Returns Query<ResultDoc[], ResultDoc, {}, IUserDocument>

  • Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

    Since

    v1.0.0

    Returns number

  • Shortcut for creating a new Document from existing raw data, pre-saved in the DB. The document returned has no paths marked as modified initially.

    Parameters

    • obj: any
    • Optional projection: AnyObject
    • Optional options: {
          setters?: boolean;
      }
      • Optional setters?: boolean

    Returns Document<unknown, {}, IUserDocument> & Omit<IUserDocument & {
        _id: ObjectId;
    }, never>

  • This function is responsible for building indexes, unless autoIndex is turned off. Mongoose calls this function automatically when a model is created using mongoose.model() or connection.model(), so you don't need to call it.

    Returns Promise<Document<unknown, {}, IUserDocument> & Omit<IUserDocument & {
        _id: ObjectId;
    }, never>>

  • Inserts one or more new documents as a single insertMany call to the MongoDB server.

    Type Parameters

    Parameters

    • docs: (IUserDocument | DocContents)[]
    • options: InsertManyOptions & {
          lean: true;
      }

    Returns Promise<MergeType<MergeType<IUserDocument, DocContents>, IUserDocument & {
        _id: ObjectId;
    }>[]>

  • Type Parameters

    Parameters

    • doc: DocContents
    • options: InsertManyOptions & {
          ordered: false;
          rawResult: true;
      }

    Returns Promise<InsertManyResult<IUserDocument> & {
        mongoose: {
            results: (Object | Error | IfAny<MergeType<MergeType<IUserDocument, DocContents>, IUserDocument & {
                _id: ObjectId;
            }>, any, Document<unknown, {}, MergeType<MergeType<IUserDocument, DocContents>, IUserDocument & {
                _id: ObjectId;
            }>> & Omit<Require_id<MergeType<MergeType<IUserDocument, DocContents>, IUserDocument & {
                _id: ObjectId;
            }>>, never>>)[];
            validationErrors: Error[];
        };
    }>

  • Type Parameters

    Parameters

    • docs: (IUserDocument | DocContents)[]
    • options: InsertManyOptions & {
          rawResult: true;
      }

    Returns Promise<InsertManyResult<IUserDocument>>

  • Type Parameters

    Parameters

    Returns Promise<IfAny<MergeType<MergeType<IUserDocument, DocContents>, IUserDocument & {
        _id: ObjectId;
    }>, any, Document<unknown, {}, MergeType<MergeType<IUserDocument, DocContents>, IUserDocument & {
        _id: ObjectId;
    }>> & Omit<Require_id<MergeType<MergeType<IUserDocument, DocContents>, IUserDocument & {
        _id: ObjectId;
    }>>, never>>[]>

  • Type Parameters

    Parameters

    • doc: DocContents
    • options: InsertManyOptions & {
          lean: true;
      }

    Returns Promise<MergeType<MergeType<IUserDocument, DocContents>, IUserDocument & {
        _id: ObjectId;
    }>[]>

  • Type Parameters

    Parameters

    • doc: DocContents
    • options: InsertManyOptions & {
          rawResult: true;
      }

    Returns Promise<InsertManyResult<IUserDocument>>

  • Type Parameters

    Parameters

    • doc: DocContents
    • options: InsertManyOptions

    Returns Promise<IfAny<MergeType<MergeType<IUserDocument, DocContents>, IUserDocument & {
        _id: ObjectId;
    }>, any, Document<unknown, {}, MergeType<MergeType<IUserDocument, DocContents>, IUserDocument & {
        _id: ObjectId;
    }>> & Omit<Require_id<MergeType<MergeType<IUserDocument, DocContents>, IUserDocument & {
        _id: ObjectId;
    }>>, never>>[]>

  • Type Parameters

    Parameters

    • doc: DocContents

    Returns Promise<IfAny<MergeType<MergeType<IUserDocument, DocContents>, IUserDocument & {
        _id: ObjectId;
    }>, any, Document<unknown, {}, MergeType<MergeType<IUserDocument, DocContents>, IUserDocument & {
        _id: ObjectId;
    }>> & Omit<Require_id<MergeType<MergeType<IUserDocument, DocContents>, IUserDocument & {
        _id: ObjectId;
    }>>, never>>[]>

  • Lists the indexes currently defined in MongoDB. This may or may not be the same as the indexes defined in your schema depending on whether you use the autoIndex option and if you build indexes manually.

    Returns Promise<any[]>

  • Returns the number of listeners listening to the event named eventName.

    Since

    v3.2.0

    Parameters

    • eventName: string | symbol

      The name of the event being listened for

    Returns number

  • Returns a copy of the array of listeners for the event named eventName.

    server.on('connection', (stream) => {
    console.log('someone connected!');
    });
    console.log(util.inspect(server.listeners('connection')));
    // Prints: [ [Function] ]

    Since

    v0.1.26

    Parameters

    • eventName: string | symbol

    Returns Function[]

  • Parameters

    • email: string
    • password: string

    Returns any

  • Alias for emitter.removeListener().

    Since

    v10.0.0

    Parameters

    • eventName: string | symbol
    • listener: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns IUserModel

  • Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple times.

    server.on('connection', (stream) => {
    console.log('someone connected!');
    });

    Returns a reference to the EventEmitter, so that calls can be chained.

    By default, event listeners are invoked in the order they are added. Theemitter.prependListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

    const myEE = new EventEmitter();
    myEE.on('foo', () => console.log('a'));
    myEE.prependListener('foo', () => console.log('b'));
    myEE.emit('foo');
    // Prints:
    // b
    // a

    Since

    v0.1.101

    Parameters

    • eventName: string | symbol

      The name of the event.

    • listener: ((...args: any[]) => void)

      The callback function

        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns IUserModel

  • Adds a one-timelistener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

    server.once('connection', (stream) => {
    console.log('Ah, we have our first user!');
    });

    Returns a reference to the EventEmitter, so that calls can be chained.

    By default, event listeners are invoked in the order they are added. Theemitter.prependOnceListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

    const myEE = new EventEmitter();
    myEE.once('foo', () => console.log('a'));
    myEE.prependOnceListener('foo', () => console.log('b'));
    myEE.emit('foo');
    // Prints:
    // b
    // a

    Since

    v0.3.0

    Parameters

    • eventName: string | symbol

      The name of the event.

    • listener: ((...args: any[]) => void)

      The callback function

        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns IUserModel

  • Populates document references.

    Parameters

    • docs: any[]
    • options: string | PopulateOptions | PopulateOptions[]

    Returns Promise<(Document<unknown, {}, IUserDocument> & Omit<IUserDocument & {
        _id: ObjectId;
    }, never>)[]>

  • Parameters

    • doc: any
    • options: string | PopulateOptions | PopulateOptions[]

    Returns Promise<Document<unknown, {}, IUserDocument> & Omit<IUserDocument & {
        _id: ObjectId;
    }, never>>

  • Type Parameters

    • Paths

    Parameters

    • docs: any[]
    • options: string | PopulateOptions | PopulateOptions[]

    Returns Promise<MergeType<Document<unknown, {}, IUserDocument> & Omit<IUserDocument & {
        _id: ObjectId;
    }, never>, Paths>[]>

  • Type Parameters

    • Paths

    Parameters

    • doc: any
    • options: string | PopulateOptions | PopulateOptions[]

    Returns Promise<MergeType<Document<unknown, {}, IUserDocument> & Omit<IUserDocument & {
        _id: ObjectId;
    }, never>, Paths>>

  • Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple times.

    server.prependListener('connection', (stream) => {
    console.log('someone connected!');
    });

    Returns a reference to the EventEmitter, so that calls can be chained.

    Since

    v6.0.0

    Parameters

    • eventName: string | symbol

      The name of the event.

    • listener: ((...args: any[]) => void)

      The callback function

        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns IUserModel

  • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

    server.prependOnceListener('connection', (stream) => {
    console.log('Ah, we have our first user!');
    });

    Returns a reference to the EventEmitter, so that calls can be chained.

    Since

    v6.0.0

    Parameters

    • eventName: string | symbol

      The name of the event.

    • listener: ((...args: any[]) => void)

      The callback function

        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns IUserModel

  • Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

    const emitter = new EventEmitter();
    emitter.once('log', () => console.log('log once'));

    // Returns a new Array with a function `onceWrapper` which has a property
    // `listener` which contains the original listener bound above
    const listeners = emitter.rawListeners('log');
    const logFnWrapper = listeners[0];

    // Logs "log once" to the console and does not unbind the `once` event
    logFnWrapper.listener();

    // Logs "log once" to the console and removes the listener
    logFnWrapper();

    emitter.on('log', () => console.log('log persistently'));
    // Will return a new Array with a single function bound by `.on()` above
    const newListeners = emitter.rawListeners('log');

    // Logs "log persistently" twice
    newListeners[0]();
    emitter.emit('log');

    Since

    v9.4.0

    Parameters

    • eventName: string | symbol

    Returns Function[]

  • Removes all listeners, or those of the specified eventName.

    It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

    Returns a reference to the EventEmitter, so that calls can be chained.

    Since

    v0.1.26

    Parameters

    • Optional event: string | symbol

    Returns IUserModel

  • Removes the specified listener from the listener array for the event namedeventName.

    const callback = (stream) => {
    console.log('someone connected!');
    };
    server.on('connection', callback);
    // ...
    server.removeListener('connection', callback);

    removeListener() will remove, at most, one instance of a listener from the listener array. If any single listener has been added multiple times to the listener array for the specified eventName, then removeListener() must be called multiple times to remove each instance.

    Once an event is emitted, all listeners attached to it at the time of emitting are called in order. This implies that anyremoveListener() or removeAllListeners() calls after emitting and before the last listener finishes execution will not remove them fromemit() in progress. Subsequent events behave as expected.

    const myEmitter = new MyEmitter();

    const callbackA = () => {
    console.log('A');
    myEmitter.removeListener('event', callbackB);
    };

    const callbackB = () => {
    console.log('B');
    };

    myEmitter.on('event', callbackA);

    myEmitter.on('event', callbackB);

    // callbackA removes listener callbackB but it will still be called.
    // Internal listener array at time of emit [callbackA, callbackB]
    myEmitter.emit('event');
    // Prints:
    // A
    // B

    // callbackB is now removed.
    // Internal listener array [callbackA]
    myEmitter.emit('event');
    // Prints:
    // A

    Because listeners are managed using an internal array, calling this will change the position indices of any listener registered after the listener being removed. This will not impact the order in which listeners are called, but it means that any copies of the listener array as returned by the emitter.listeners() method will need to be recreated.

    When a single function has been added as a handler multiple times for a single event (as in the example below), removeListener() will remove the most recently added instance. In the example the once('ping')listener is removed:

    const ee = new EventEmitter();

    function pong() {
    console.log('pong');
    }

    ee.on('ping', pong);
    ee.once('ping', pong);
    ee.removeListener('ping', pong);

    ee.emit('ping');
    ee.emit('ping');

    Returns a reference to the EventEmitter, so that calls can be chained.

    Since

    v0.1.26

    Parameters

    • eventName: string | symbol
    • listener: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns IUserModel

  • Creates a replaceOne query: finds the first document that matches filter and replaces it with replacement.

    Type Parameters

    Parameters

    Returns Query<UpdateResult, ResultDoc, {}, IUserDocument>

  • By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

    Returns a reference to the EventEmitter, so that calls can be chained.

    Since

    v0.3.5

    Parameters

    • n: number

    Returns IUserModel

  • Parameters

    • email: string
    • password: string
    • role: string

    Returns any

  • Starts a MongoDB session for benefits like causal consistency, retryable writes, and transactions.

    Parameters

    • Optional options: ClientSessionOptions

    Returns Promise<ClientSession>

  • Makes the indexes in MongoDB match the indexes defined in this model's schema. This function will drop any indexes that are not defined in the model's schema except the _id index, and build any indexes that are in your schema but not in MongoDB.

    Parameters

    • Optional options: SyncIndexesOptions

    Returns Promise<string[]>

  • Translate any aliases fields/conditions so the final query or document object is pure

    Parameters

    • raw: any

    Returns any

  • Creates a updateMany query: updates all documents that match filter with update.

    Type Parameters

    Parameters

    Returns Query<UpdateResult, ResultDoc, {}, IUserDocument>

  • Creates a updateOne query: updates the first document that matches filter with update.

    Type Parameters

    Parameters

    Returns Query<UpdateResult, ResultDoc, {}, IUserDocument>

  • Casts and validates the given object against this model's schema, passing the given context to custom validators.

    Returns Promise<void>

  • Parameters

    • optional: any

    Returns Promise<void>

  • Parameters

    • optional: any
    • pathsToValidate: PathsToValidate

    Returns Promise<void>

  • Watches the underlying collection for changes using MongoDB change streams.

    Type Parameters

    • ResultType extends Document = any

    Parameters

    • Optional pipeline: Record<string, unknown>[]
    • Optional options: ChangeStreamOptions & {
          hydrate?: boolean;
      }

    Returns ChangeStream<ResultType, ChangeStreamDocument<ResultType>>

  • Creates a Query, applies the passed conditions, and returns the Query.

    Type Parameters

    Parameters

    • path: string
    • Optional val: any

    Returns Query<ResultDoc[], ResultDoc, {}, IUserDocument>

  • Type Parameters

    Parameters

    • obj: object

    Returns Query<ResultDoc[], ResultDoc, {}, IUserDocument>

  • Type Parameters

    Returns Query<ResultDoc[], ResultDoc, {}, IUserDocument>