Optionaldoc: DocTypeOptionalfields: anyOptionaloptions: boolean | AnyObjectIf 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[captureRest...args: AnyRestAlias for emitter.on(eventName, listener).
Rest...args: any[]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.
Optionaloptions: MongooseBulkSaveOptionsSends 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.
Optionaloptions: MongooseBulkWriteOptionsOptionaloptions: { OptionalignoreCreates a countDocuments query: counts the number of documents that match filter.
Optionalfilter: FilterQuery<TRawDocType>Optionaloptions: null | CountOptions & Pick<QueryOptions<TRawDocType>, MongooseBaseQueryOptionKeys> & { Creates a new document or documents
Optionaloptions: CreateOptionsRest...docs: (TRawDocType | DocContents)[]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.
Optionaloptions: CreateCollectionOptions & Pick<SchemaOptions<unknown, {}, {}, {}, {}, Document<unknown, {}, unknown> & { Similar to ensureIndexes(), except for it uses the createIndex
function.
Optionaloptions: CreateIndexesOptionsCreate an Atlas search index. This function only works when connected to MongoDB Atlas.
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.
Optionalfilter: FilterQuery<TRawDocType>Optionaloptions: null | DeleteOptions & Pick<QueryOptions<TRawDocType>, MongooseBaseQueryOptionKeys> & { Deletes the first document that matches conditions from the collection.
Behaves like remove(), but deletes at most one document regardless of the
single option.
Optionalfilter: FilterQuery<TRawDocType>Optionaloptions: null | DeleteOptions & Pick<QueryOptions<TRawDocType>, MongooseBaseQueryOptionKeys> & { Adds a discriminator type.
Optionalvalue: Optionalvalue: Creates a distinct query: returns the distinct values of the given field that match filter.
Optionalfilter: FilterQuery<TRawDocType>Delete an existing Atlas search index by name. This function only works when connected to MongoDB Atlas.
Synchronously calls each of the listeners registered for the event named eventName, 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: AnyRestCreates a estimatedDocumentCount query: counts the number of documents in the collection.
Optionaloptions: QueryOptions<TRawDocType>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) ]
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.
Optionalprojection: null | ProjectionType<TRawDocType>Optionaloptions: null | QueryOptions<TRawDocType>Optionalprojection: null | ProjectionType<TRawDocType>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().
Optionalprojection: null | ProjectionType<TRawDocType>Optionaloptions: null | QueryOptions<TRawDocType>Optionalprojection: null | ProjectionType<TRawDocType>Creates a findByIdAndDelete query, filtering by the given _id.
Optionalid: anyOptionaloptions: null | QueryOptions<TRawDocType>Creates a findOneAndUpdate query, filtering by the given _id.
Optionalid: anyOptionalupdate: UpdateQuery<TRawDocType>Optionaloptions: null | QueryOptions<TRawDocType>Finds one document.
Optionalfilter: FilterQuery<TRawDocType>Optionalprojection: null | ProjectionType<TRawDocType>Optionaloptions: null | QueryOptions<TRawDocType>Optionalfilter: FilterQuery<TRawDocType>Optionalprojection: null | ProjectionType<TRawDocType>Optionalfilter: FilterQuery<TRawDocType>Creates a findOneAndDelete query: atomically finds the given document, deletes it, and returns the document as it was before deletion.
Optionalfilter: null | FilterQuery<TRawDocType>Optionaloptions: null | QueryOptions<TRawDocType>Creates a findOneAndReplace query: atomically finds the given document and replaces it with replacement.
Optionalfilter: FilterQuery<TRawDocType>Optionalreplacement: AnyObject | TRawDocTypeOptionaloptions: null | QueryOptions<TRawDocType>Creates a findOneAndUpdate query: atomically find the first document that matches filter and apply update.
Optionalfilter: FilterQuery<TRawDocType>Optionalupdate: UpdateQuery<TRawDocType>Optionaloptions: null | QueryOptions<TRawDocType>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.
Optionalprojection: AnyObjectOptionaloptions: HydrateOptionsThis 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.
List all Atlas search indexes on this model's collection. This function only works when connected to MongoDB Atlas.
Optionaloptions: ListSearchIndexesOptionsReturns the number of listeners listening for the event named eventName.
If listener is provided, it will return how many times the listener is found
in the list of the listeners of the event.
The name of the event being listened for
Optionallistener: FunctionThe event handler function
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] ]
Alias for emitter.removeListener().
Rest...args: any[]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. The emitter.prependListener() method can be used as an alternative to add the
event listener to the beginning of the listeners array.
import { EventEmitter } from 'node:events';
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[]Adds a one-time listener 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. The emitter.prependOnceListener() method can be used as an alternative to add the
event listener to the beginning of the listeners array.
import { EventEmitter } from 'node:events';
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[]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[]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[]Returns a copy of the array of listeners for the event named eventName,
including any wrappers (such as those created by .once()).
import { EventEmitter } from 'node:events';
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');
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.
OptionaleventName: string | symbolRemoves the specified listener from the listener array for the event named eventName.
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 any removeListener() or removeAllListeners() calls after emitting and before the last listener finishes execution
will not remove them fromemit() in progress. Subsequent events behave as expected.
import { EventEmitter } from 'node:events';
class MyEmitter extends EventEmitter {}
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:
import { EventEmitter } from 'node:events';
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[]Creates a replaceOne query: finds the first document that matches filter and replaces it with replacement.
Optionalfilter: FilterQuery<TRawDocType>Optionalreplacement: AnyObject | TRawDocTypeOptionaloptions: null | ReplaceOptions & Pick<QueryOptions<TRawDocType>, MongooseBaseQueryOptionKeys | "timestamps" | "lean"> & { 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 to Infinity (or 0) to indicate an unlimited number of listeners.
Returns a reference to the EventEmitter, so that calls can be chained.
Starts a MongoDB session for benefits like causal consistency, retryable writes, and transactions.
Optionaloptions: ClientSessionOptionsMakes 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.
Optionaloptions: SyncIndexesOptionsCreates a updateMany query: updates all documents that match filter with update.
Optionalfilter: FilterQuery<TRawDocType>Optionalupdate: UpdateWithAggregationPipeline | UpdateQuery<TRawDocType>Optionaloptions: null | UpdateOptions & Pick<QueryOptions<TRawDocType>, MongooseBaseQueryOptionKeys | "timestamps"> & { Creates a updateOne query: updates the first document that matches filter with update.
Optionalfilter: FilterQuery<TRawDocType>Optionalupdate: UpdateWithAggregationPipeline | UpdateQuery<TRawDocType>Optionaloptions: null | UpdateOptions & Pick<QueryOptions<TRawDocType>, MongooseBaseQueryOptionKeys | "timestamps"> & { Update an existing Atlas search index. This function only works when connected to MongoDB Atlas.
Casts and validates the given object against this model's schema, passing the given context to custom validators.
OptionalpathsWatches the underlying collection for changes using MongoDB change streams.
Optionalpipeline: Record<string, unknown>[]Optionaloptions: ChangeStreamOptions & { Creates a Query, applies the passed conditions, and returns the Query.
Optionalval: any
Base Mongoose instance the model uses.