AbstractAbstractProtectedsignalStaticcaptureValue: boolean
Change the default captureRejections option on all new EventEmitter objects.
Static ReadonlycaptureValue: Symbol.for('nodejs.rejection')
See how to write a custom rejection handler.
Static ReadonlyCLOSEStaticdefaultBy default, a maximum of 10 listeners can be registered for any single
+
Static ReadonlyCLOSEStaticdefaultBy default, a maximum of 10 listeners can be registered for any single
event. This limit can be changed for individual EventEmitter instances
using the emitter.setMaxListeners(n) method. To change the default
for allEventEmitter instances, the events.defaultMaxListeners property
@@ -90,16 +90,16 @@
regular 'error' listener is installed.
The cursor is closed and all remaining locally buffered documents have been iterated.
-The cursor has no id until it receives a response from the initial cursor creating command.
+A killCursors command was attempted on this cursor.
+
A killCursors command was attempted on this cursor.
This is performed if the cursor id is non zero.
Optional[captureRest...args: AnyRestOptional[captureRest...args: AnyRestAdd a cursor flag to the cursor
The flag to set, must be one of following ['tailable', 'oplogReplay', 'noCursorTimeout', 'awaitData', 'partial' -.
The flag boolean value.
-Alias for emitter.on(eventName, listener).
Alias for emitter.on(eventName, listener).
Alias for emitter.on(eventName, listener).
Set the batch size for the cursor.
The number of documents to return per batch. See command documentation.
-AbstractcloneReturns a new uninitialized copy of this cursor, with options matching those that have been set on the current instance
-Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments
+
AbstractcloneReturns a new uninitialized copy of this cursor, with options matching those that have been set on the current instance
+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
@@ -129,10 +129,10 @@
Returns the current max listener value for the EventEmitter which is either
set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.
Returns the number of listeners listening for the event named eventName.
+
Returns 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.
Alias for emitter.removeListener().
Alias for emitter.removeListener().
Alias for emitter.removeListener().
v10.0.0
@@ -316,7 +316,7 @@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).
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.
Returns an array of documents. The caller is responsible for making sure that there +
Returns an array of documents. The caller is responsible for making sure that there is enough memory to store the results. Note that the array only contains partial results when this cursor had been previously accessed. In that case, cursor.rewind() can be used to reset the cursor.
-Set the ReadPreference for the cursor.
-Set the ReadPreference for the cursor.
+Set the ReadPreference for the cursor.
+Set the ReadPreference for the cursor.
The new read preference for the cursor.
-StaticaddStaticaddListens once to the abort event on the provided signal.
Listening to the abort event on abort signals is unsafe and may
lead to resource leaks since another third party with the signal can
call e.stopImmediatePropagation(). Unfortunately Node.js cannot change
diff --git a/docs/Next/classes/AggregationCursor.html b/docs/Next/classes/AggregationCursor.html
index 2f378e34f69..157617f888c 100644
--- a/docs/Next/classes/AggregationCursor.html
+++ b/docs/Next/classes/AggregationCursor.html
@@ -73,13 +73,13 @@
on
once
set
ReadonlypipelineProtectedsignalStaticcaptureValue: boolean
Change the default captureRejections option on all new EventEmitter objects.
Static ReadonlycaptureValue: Symbol.for('nodejs.rejection')
See how to write a custom rejection handler.
Static ReadonlyCLOSEStaticdefaultBy default, a maximum of 10 listeners can be registered for any single
+
Static ReadonlyCLOSEStaticdefaultBy default, a maximum of 10 listeners can be registered for any single
event. This limit can be changed for individual EventEmitter instances
using the emitter.setMaxListeners(n) method. To change the default
for allEventEmitter instances, the events.defaultMaxListeners property
@@ -109,16 +109,16 @@
regular 'error' listener is installed.
The cursor is closed and all remaining locally buffered documents have been iterated.
-The cursor has no id until it receives a response from the initial cursor creating command.
+A killCursors command was attempted on this cursor.
+
A killCursors command was attempted on this cursor.
This is performed if the cursor id is non zero.
Optional[captureRest...args: AnyRestOptional[captureRest...args: AnyRestAdd a cursor flag to the cursor
The flag to set, must be one of following ['tailable', 'oplogReplay', 'noCursorTimeout', 'awaitData', 'partial' -.
The flag boolean value.
-Alias for emitter.on(eventName, listener).
Alias for emitter.on(eventName, listener).
Alias for emitter.on(eventName, listener).
v0.1.26
@@ -133,10 +133,10 @@Set the batch size for the cursor.
The number of documents to return per batch. See command documentation.
-Returns a new uninitialized copy of this cursor, with options matching those that have been set on the current instance
+Returns a new uninitialized copy of this cursor, with options matching those that have been set on the current instance
Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments
+
Optionaloptions: { OptionaltimeoutMS?: numberSynchronously 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
@@ -159,12 +159,12 @@ Example- (doc): boolean | void
Parameters
- doc: TSchema
Returns boolean | void
Add a geoNear stage to the aggregation pipeline
Returns the current max listener value for the EventEmitter which is either
set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.
Add a group stage to the aggregation pipeline
-Add a limit stage to the aggregation pipeline
+Returns 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.
Add a match stage to the aggregation pipeline
Alias for emitter.removeListener().
Alias for emitter.removeListener().
Alias for emitter.removeListener().
v10.0.0
@@ -363,7 +363,7 @@Add a redact stage to the aggregation pipeline
+Optionalnumber: numberAdd a redact stage to the aggregation pipeline
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
@@ -454,7 +454,7 @@
ProtectedresolveOptionalverbosity: ExplainVerbosityLike | ExplainCommandOptions | { Optionaloptions: { OptionaltimeoutMS?: numberOptionalexplain?: ExplainVerbosityLike | ExplainCommandOptionsOptionaltimeout?: { OptionaltimeoutMS?: numberBy 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.
Add a sort stage to the aggregation pipeline
-Returns an array of documents. The caller is responsible for making sure that there is enough memory to store the results. Note that the array only contains partial results when this cursor had been previously accessed. In that case, cursor.rewind() can be used to reset the cursor.
-Add a unwind stage to the aggregation pipeline
+Add a unwind stage to the aggregation pipeline
Set the ReadPreference for the cursor.
-Set the ReadPreference for the cursor.
+Set the ReadPreference for the cursor.
The new read preference for the cursor.
-StaticaddStaticaddListens once to the abort event on the provided signal.
Listening to the abort event on abort signals is unsafe and may
lead to resource leaks since another third party with the signal can
call e.stopImmediatePropagation(). Unfortunately Node.js cannot change
diff --git a/docs/Next/classes/BSON.Long.html b/docs/Next/classes/BSON.Long.html
index f9e881a9241..652712eccd1 100644
--- a/docs/Next/classes/BSON.Long.html
+++ b/docs/Next/classes/BSON.Long.html
@@ -125,29 +125,29 @@
StaticZEROSigned zero
This is an alias of Long.compare
-This is an alias of Long.divide
-This is an alias of Long.equals
-Tests if this Long's value equals the specified's.
-This is an alias of Long.isZero
This is an alias of Long.greaterThanOrEqual
-This is an alias of Long.greaterThan
-This is an alias of Long.greaterThanOrEqual
-This is an alias of Long.greaterThan
+This is an alias of Long.greaterThanOrEqual
+This is an alias of Long.lessThanOrEqual
-This is an alias of Long#lessThan.
-This is an alias of Long.lessThanOrEqual
-This is an alias of Long.modulo
-This is an alias of Long.multiply
-Returns the product of this and the specified Long.
-This is an alias of Long#lessThan.
+This is an alias of Long.lessThanOrEqual
+This is an alias of Long.modulo
+This is an alias of Long.multiply
+This is an alias of Long.notEquals
-This is an alias of Long.negate
+This is an alias of Long.negate
This is an alias of Long.notEquals
-Returns the bitwise NOT of this Long.
+Returns the bitwise OR of this Long and the specified.
+This is an alias of Long.modulo
-This is an alias of Long.shiftRightUnsigned
This is an alias of Long.shiftRightUnsigned
This is an alias of Long.subtract
-Returns the difference of this and the specified Long.
-To generate a new ObjectId, use ObjectId() with no argument.
-Create ObjectId from a 24 character hex string.
+Create ObjectId from a 24 character hex string.
A 24 character hex string.
-Create ObjectId from the BSON ObjectId type.
+Create ObjectId from the BSON ObjectId type.
The BSON ObjectId type.
-Create ObjectId from the object type that has the toHexString method.
+Create ObjectId from the object type that has the toHexString method.
The ObjectIdLike type.
-Create ObjectId from a 12 byte binary Buffer.
+Create ObjectId from a 12 byte binary Buffer.
A 12 byte binary Buffer.
-Implementation overload.
+Implementation overload.
OptionalinputId: All input types that are used in the constructor implementation.
-The ObjectId bytes
-The ObjectId bytes
+Compares the equality of this ObjectId with otherID.
ObjectId instance to compare against.
-Converts the id into a 24 character hex string for printing, unless encoding is provided.
+StaticcreateStaticcreateCreates an ObjectId from a hex string representation of an ObjectId.
+StaticcreateStaticcreateStaticcreateCreates an ObjectId from a second based number, with the rest of the ObjectId zeroed out. Used for comparisons or sorting the ObjectId.
+StaticcreateStaticgenerateStaticgenerateStaticisStaticisChecks if a value can be used to create a valid bson ObjectId
any JS value
-A 64-bit bigint representing the Timestamp.
-A 64-bit Long representing the Timestamp.
-A pair of two values indicating timestamp and increment.
-This is an alias of Long.compare
-This is an alias of Long.divide
-This is an alias of Long.equals
-This is an alias of Long.isZero
-This is an alias of Long.greaterThanOrEqual
-Gets the high 32 bits as a signed integer.
-Gets the high 32 bits as an unsigned integer.
-Gets the low 32 bits as a signed integer.
-Gets the low 32 bits as an unsigned integer.
-Gets the number of bits needed to represent the absolute value of this Long.
-This is an alias of Long.greaterThan
-This is an alias of Long.greaterThanOrEqual
-Tests if this Long's value is even.
-Tests if this Long's value is negative.
-Tests if this Long's value is odd.
-Tests if this Long's value is positive.
-Tests if this Long's value equals zero.
-This is an alias of Long.lessThanOrEqual
-This is an alias of Long#lessThan.
-This is an alias of Long.lessThanOrEqual
-This is an alias of Long.modulo
-This is an alias of Long.multiply
-Returns the product of this and the specified Long.
-A 64-bit Long representing the Timestamp.
+A pair of two values indicating timestamp and increment.
+This is an alias of Long.compare
+This is an alias of Long.divide
+This is an alias of Long.equals
+This is an alias of Long.isZero
+This is an alias of Long.greaterThanOrEqual
+Gets the high 32 bits as a signed integer.
+Gets the high 32 bits as an unsigned integer.
+Gets the low 32 bits as a signed integer.
+Gets the low 32 bits as an unsigned integer.
+Gets the number of bits needed to represent the absolute value of this Long.
+This is an alias of Long.greaterThan
+This is an alias of Long.greaterThanOrEqual
+Tests if this Long's value is even.
+Tests if this Long's value is negative.
+Tests if this Long's value is odd.
+Tests if this Long's value is positive.
+Tests if this Long's value equals zero.
+This is an alias of Long.lessThanOrEqual
+This is an alias of Long#lessThan.
+This is an alias of Long.lessThanOrEqual
+This is an alias of Long.modulo
+This is an alias of Long.multiply
+This is an alias of Long.notEquals
-This is an alias of Long.negate
-This is an alias of Long.notEquals
-This is an alias of Long.modulo
-Returns this Long with bits shifted to the left by the given amount.
+This is an alias of Long.notEquals
+This is an alias of Long.negate
+This is an alias of Long.notEquals
+This is an alias of Long.modulo
+Returns this Long with bits arithmetically shifted to the right by the given amount.
+Returns this Long with bits logically shifted to the right by the given amount.
+This is an alias of Long.shiftLeft
-This is an alias of Long.shiftRight
-This is an alias of Long.shiftRightUnsigned
-This is an alias of Long.shiftRightUnsigned
-This is an alias of Long.subtract
-Returns the difference of this and the specified Long.
-Subtrahend
+This is an alias of Long.shiftLeft
+This is an alias of Long.shiftRight
+This is an alias of Long.shiftRightUnsigned
+This is an alias of Long.shiftRightUnsigned
+This is an alias of Long.subtract
+Converts the Long to a BigInt (arbitrary precision).
-Converts this Long to its byte representation.
+Converts the Long to a BigInt (arbitrary precision).
+Converts this Long to its byte representation.
Optionalle: booleanWhether little or big endian, defaults to big endian
Byte representation
-Converts this Long to its big endian byte representation.
+Not applicable to Timestamp; use .t for seconds since the Unix epoch, or .i for the increment ordinal.
Converts this Long to its big endian byte representation.
Big endian byte representation
-Converts this Long to its little endian byte representation.
+Not applicable to Timestamp; use .t for seconds since the Unix epoch, or .i for the increment ordinal.
Converts this Long to its little endian byte representation.
Little endian byte representation
-Converts the Long to a 32 bit integer, assuming it is a 32 bit integer.
-Converts the Long to a the nearest floating-point representation of this value (double, 53 bit mantissa).
-Converts the Long to a string written in the specified radix.
+Not applicable to Timestamp; use .t for seconds since the Unix epoch, or .i for the increment ordinal.
Converts the Long to a 32 bit integer, assuming it is a 32 bit integer.
+Converts the Long to a the nearest floating-point representation of this value (double, 53 bit mantissa).
+Static ReadonlyMAX_An incrementing ordinal for operations within a given second.
-A time_t value measuring seconds since the Unix epoch
StaticfromReturns a Timestamp for the given high and low bits. Each is assumed to use 32 bits.
+Static ReadonlyMAX_An incrementing ordinal for operations within a given second.
+A time_t value measuring seconds since the Unix epoch
StaticfromStaticfromStaticfromStaticfromReturns a Timestamp from the given string, optionally using the given radix.
+StaticfromStaticfromStaticfromA class representation of the BSON UUID type.
-Create a UUID type
When the argument to the constructor is omitted a random v4 UUID will be generated.
Optionalinput: string | Uint8Array<ArrayBufferLike> | UUIDCan be a 32 or 36 character hex string (dashes excluded/included) or a 16 byte binary Buffer.
-The bytes of the Binary value.
The format of a Binary value in BSON is defined as:
binary ::= int32 subtype (byte*)
Static ReadonlySUBTYPE_Vector BSON type
Static ReadonlyVECTOR_datatype of a Binary Vector (subtype: 9)
The UUID bytes
-Compares the equality of this UUID with otherID.
UUID instance to compare against.
-the length of the binary sequence
+If this Binary represents a Packed bit Vector (binary.buffer[0] === Binary.VECTOR_TYPE.PackedBit),
+
If this Binary represents a Packed bit Vector (binary.buffer[0] === Binary.VECTOR_TYPE.PackedBit),
returns a copy of the bit unpacked into a new Int8Array.
Use toPackedBits to get the bits still in packed form.
If the Binary is not a Vector, or the datatype is not PackedBit, an error is thrown.
@@ -110,30 +110,30 @@If the Binary is not a Vector, or the datatype is not Float32, an error is thrown.
If this Binary represents packed bit Vector (binary.buffer[0] === Binary.VECTOR_TYPE.PackedBit),
returns a copy of the bytes that are packed bits.
Use toBits to get the unpacked bits.
If the Binary is not a Vector, or the datatype is not PackedBit, an error is thrown.
Writes a buffer to the binary.
a string or buffer to be written to the Binary BSON object.
specify the binary of where to write the content.
StaticcreateStaticcreateStaticcreateStaticfromConstructs a Binary representing an Packed Bit Vector.
+StaticfromStaticfromStaticfromStaticfromStaticgenerateStaticisStaticis
Value: boolean
+