Optional doc: DocTypeOptional Optional fields: anyOptional Optional options: boolean | AnyObjectOptional Base Mongoose instance the model uses.
If this is a discriminator model, baseModelName is the name of
the base model.
Collection the model uses.
Connection the model uses.
Registered discriminators for this model.
Event emitter that reports any errors that occurred. Useful for global error handling.
The name of the model
Schema the model uses.
Adds a $where clause to this query
Optional [captureAlias for emitter.on(eventName, listener).
Rest ...args: any[]Rest v0.1.26
Optional pipeline: PipelineStage[]Optional Optional options: mongoose.AggregateOptionsOptional 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.
Optional options: BulkWriteOptions & { Optional 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.
Optional options: BulkWriteOptions & MongooseBulkWriteOptionsOptional Optional options: { Optional
Optional ignoreCreates a count query: counts the number of documents that match filter.
Optional filter: FilterQuery<TRawDocType>Optional Creates a countDocuments query: counts the number of documents that match filter.
Optional filter: FilterQuery<TRawDocType>Optional Optional options: mongoose.QueryOptions<TRawDocType>Optional Creates a new document or documents
Optional options: CreateOptionsOptional Rest ...docs: (TRawDocType | DocContents)[]Rest 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.
Optional options: CreateCollectionOptions & Pick<SchemaOptions<unknown, {}, {}, {}, {}, mongoose.Document<unknown, {}, unknown> & Required<{ Optional Similar to ensureIndexes(), except for it uses the createIndex
function.
Optional options: CreateIndexesOptionsOptional 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.
Optional filter: FilterQuery<TRawDocType>Optional Optional options: mongoose.QueryOptions<TRawDocType>Optional Deletes the first document that matches conditions from the collection.
Behaves like remove(), but deletes at most one document regardless of the
single option.
Optional filter: FilterQuery<TRawDocType>Optional Optional options: mongoose.QueryOptions<TRawDocType>Optional Does a dry-run of Model.syncIndexes(), meaning that the result of this function would be the result of Model.syncIndexes().
Optional options: Record<string, unknown>Optional Adds a discriminator type.
Optional value: string | number | mongoose.Schema.Types.ObjectId | DiscriminatorOptionsOptional Optional value: string | number | mongoose.Schema.Types.ObjectId | DiscriminatorOptionsOptional Creates a distinct query: returns the distinct values of the given field that match filter.
Optional filter: FilterQuery<TRawDocType>Optional 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.
import EventEmitter from 'node: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
Rest ...args: AnyRestRest v0.1.26
Sends createIndex commands to mongo for each index declared in the schema.
The createIndex commands are sent in series.
Optional options: CreateIndexesOptionsOptional Creates a estimatedDocumentCount query: counts the number of documents in the collection.
Optional options: mongoose.QueryOptions<TRawDocType>Optional Returns an array listing the events for which the emitter has registered
listeners. The values in the array are strings or Symbols.
import EventEmitter from 'node: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) ]
v6.0.0
Returns a document with its _id if at least one document exists in the database that matches
the given filter, and null otherwise.
Creates a find query: gets a list of documents that match filter.
Optional projection: ProjectionType<TRawDocType>Optional Optional options: mongoose.QueryOptions<TRawDocType>Optional Optional projection: ProjectionType<TRawDocType>Optional 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().
Optional projection: ProjectionType<TRawDocType>Optional Optional options: mongoose.QueryOptions<TRawDocType>Optional Optional projection: ProjectionType<TRawDocType>Optional Creates a findByIdAndDelete query, filtering by the given _id.
Optional id: anyOptional Optional options: mongoose.QueryOptions<TRawDocType>Optional Creates a findByIdAndRemove query, filtering by the given _id.
Optional id: anyOptional Optional options: mongoose.QueryOptions<TRawDocType>Optional Creates a findOneAndUpdate query, filtering by the given _id.
Optional id: anyOptional Optional update: UpdateQuery<TRawDocType>Optional Optional options: mongoose.QueryOptions<TRawDocType>Optional Finds one document.
Optional filter: FilterQuery<TRawDocType>Optional Optional projection: ProjectionType<TRawDocType>Optional Optional options: mongoose.QueryOptions<TRawDocType>Optional Optional filter: FilterQuery<TRawDocType>Optional Optional projection: ProjectionType<TRawDocType>Optional Optional filter: FilterQuery<TRawDocType>Optional Creates a findOneAndDelete query: atomically finds the given document, deletes it, and returns the document as it was before deletion.
Optional filter: FilterQuery<TRawDocType>Optional Optional options: mongoose.QueryOptions<TRawDocType> & { Optional Optional filter: FilterQuery<TRawDocType>Optional Optional options: mongoose.QueryOptions<TRawDocType>Optional Creates a findOneAndRemove query: atomically finds the given document and deletes it.
Optional filter: FilterQuery<TRawDocType>Optional Optional options: mongoose.QueryOptions<TRawDocType>Optional Creates a findOneAndReplace query: atomically finds the given document and replaces it with replacement.
Optional filter: FilterQuery<TRawDocType>Optional Optional replacement: TRawDocType | AnyObjectOptional Optional options: mongoose.QueryOptions<TRawDocType>Optional Creates a findOneAndUpdate query: atomically find the first document that matches filter and apply update.
Optional filter: FilterQuery<TRawDocType>Optional Optional update: UpdateQuery<TRawDocType>Optional Optional options: mongoose.QueryOptions<TRawDocType>Optional 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.
Optional projection: AnyObjectOptional Optional options: { Optional
Optional setters?: booleanThis 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.
Inserts one or more new documents as a single insertMany call to the MongoDB server.
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 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] ]
v0.1.26
Alias for emitter.removeListener().
Rest ...args: any[]Rest v10.0.0
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 eventName and 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
The name of the event.
The callback function
Rest ...args: any[]Rest v0.1.101
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
The name of the event.
The callback function
Rest ...args: any[]Rest v0.3.0
Populates document references.
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 eventName and 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.
The name of the event.
The callback function
Rest ...args: any[]Rest v6.0.0
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.
The name of the event.
The callback function
Rest ...args: any[]Rest v6.0.0
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');
v9.4.0
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.
Optional event: string | symbolOptional v0.1.26
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.
Rest ...args: any[]Rest v0.1.26
Creates a replaceOne query: finds the first document that matches filter and replaces it with replacement.
Optional filter: FilterQuery<TRawDocType>Optional Optional replacement: TRawDocType | AnyObjectOptional Optional options: mongoose.QueryOptions<TRawDocType>Optional 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.
v0.3.5
Starts a MongoDB session for benefits like causal consistency, retryable writes, and transactions.
Optional options: mongoose.mongo.ClientSessionOptionsOptional 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.
Optional options: SyncIndexesOptionsOptional Creates a updateMany query: updates all documents that match filter with update.
Optional filter: FilterQuery<TRawDocType>Optional Optional update: UpdateWithAggregationPipeline | UpdateQuery<TRawDocType>Optional Optional options: mongoose.QueryOptions<TRawDocType>Optional Creates a updateOne query: updates the first document that matches filter with update.
Optional filter: FilterQuery<TRawDocType>Optional Optional update: UpdateWithAggregationPipeline | UpdateQuery<TRawDocType>Optional Optional options: mongoose.QueryOptions<TRawDocType>Optional Casts and validates the given object against this model's schema, passing the given context to custom validators.
Optional pathsWatches the underlying collection for changes using MongoDB change streams.
Optional pipeline: Record<string, unknown>[]Optional Optional options: ChangeStreamOptions & { Optional Creates a Query, applies the passed conditions, and returns the Query.
Optional val: anyOptional Generated using TypeDoc
Models are fancy constructors compiled from
Schemadefinitions. An instance of a model is called a document. Models are responsible for creating and reading documents from the underlying MongoDB database