Optional
writeWriteConcern can still be present on the options because we inherit options from the client/db/collection. WriteConcern
仍然可以出现在选项上,因为我们从客户端/db/集合继承了选项。The key must be present on the options in order to delete it. 键必须存在于选项中才能删除它。This allows typescript to delete the key but will not allow a writeConcern to be assigned as a property on options.这允许typescript删除键,但不允许将writeConcern
分配为选项的属性。
Optional
streamStatic
Readonly
CHANGEFired for each new matching change in the specified namespace. 为指定命名空间中的每个新匹配更改激发。Attaching a 将change
event listener to a Change Stream will switch the stream into flowing mode. change
事件侦听器附加到更改流将使流切换到流动模式。Data will then be passed as soon as it is available.一旦数据可用,就会立即传递。
Static
Readonly
CLOSEStatic
Readonly
ENDStatic
Readonly
ERRORStatic
Readonly
INITStatic
Readonly
MOREStatic
Readonly
RESPONSEStatic
Readonly
RESUME_Emitted each time the change stream stores a new resume token.每次更改流存储新的恢复令牌时发出。
Static
Readonly
captureStatic
captureSets or gets the default captureRejection value for all emitters.设置或获取所有发射器的默认captureRejection值。
Static
defaultStatic
Readonly
errorThis symbol shall be used to install a listener for only monitoring 此符号应用于安装仅用于监视“错误”事件的侦听器。'error'
events. Listeners installed using this symbol are called before the regular 在调用常规'error'
listeners are called.'error'
侦听器之前,将调用使用此符号安装的侦听器。
Installing a listener using this symbol does not change the behavior once an 一旦发出'error'
event is emitted, therefore the process will still crash if no regular 'error'
listener is installed.'error'
事件,使用此符号安装侦听器不会改变行为,因此,如果未安装常规的'error'
侦听器,进程仍将崩溃。
Is the cursor closed游标是否关闭
The cached resume token that is used to resume after the most recently returned change.缓存的恢复令牌,用于在最近返回的更改之后恢复。
Rest
...args: Parameters<ChangeStreamEvents<TSchema, TChange>[EventKey]>Optional
event: string | symbol | EventKeyReturn a modified Readable stream including a possible transform method.返回一个修改后的Readable流,其中包括一个可能的转换方法。
NOTE: When using a Stream to process change stream events, the stream will NOT automatically resume in the case a resumable error is encountered.注意:当使用流处理更改流事件时,如果遇到可恢复的错误,流将不会自动恢复。
Optional
options: CursorStreamOptionsMongoChangeStreamError if the underlying cursor or the change stream is closed如果基础游标或更改流已关闭则抛出MongoChangeStreamError
Static
getReturns a copy of the array of listeners for the event named 返回名为eventName
.eventName
的事件的侦听器数组的副本。
For 对于EventEmitter
s this behaves exactly the same as calling .listeners
on the emitter.EventEmitter
,其行为与在发射器上调用侦听器完全相同。
For 对于EventTarget
s this is the only way to get the event listeners for the event target. EventTarget
,这是获取事件目标的事件侦听器的唯一方法。This is useful for debugging and diagnostic purposes.这对于调试和诊断非常有用。
import { getEventListeners, EventEmitter } from 'node:events';
{
const ee = new EventEmitter();
const listener = () => console.log('Events are fun');
ee.on('foo', listener);
console.log(getEventListeners(ee, 'foo')); // [ [Function: listener] ]
}
{
const et = new EventTarget();
const listener = () => console.log('Events are fun');
et.addEventListener('foo', listener);
console.log(getEventListeners(et, 'foo')); // [ [Function: listener] ]
}
v15.2.0, v14.17.0
Static
listenerA class method that returns the number of listeners for the given 一个类方法,用于返回在给定eventName
registered on the given emitter
.emitter
上注册的给定eventName
的侦听器数。
import { EventEmitter, listenerCount } from 'node:events';
const myEmitter = new EventEmitter();
myEmitter.on('event', () => {});
myEmitter.on('event', () => {});
console.log(listenerCount(myEmitter, 'event'));
// Prints: 2
The emitter to query要查询的发射器
The event name事件名称
v0.9.12
Since v3.2.0 - Use 请改用listenerCount
instead.listenerCount
Static
onimport { on, EventEmitter } from 'node:events';
import process from 'node:process';
const ee = new EventEmitter();
// Emit later on
process.nextTick(() => {
ee.emit('foo', 'bar');
ee.emit('foo', 42);
});
for await (const event of on(ee, 'foo')) {
// The execution of this inner block is synchronous and it
// processes one event at a time (even with await). Do not use
// if concurrent execution is required.
console.log(event); // prints ['bar'] [42]
}
// Unreachable here
Returns an 返回一个迭代AsyncIterator
that iterates eventName
events. eventName
事件的AsyncIterator
。It will throw if the 如果EventEmitter
emits 'error'
. EventEmitter
发出'error'
,它将抛出。It removes all listeners when exiting the loop. 它在退出循环时删除所有侦听器。The 每次迭代返回的value
returned by each iteration is an array composed of the emitted event arguments.value
是一个由发出的事件参数组成的数组。
An AbortSignal
can be used to cancel waiting on events:AbortSignal
可用于取消等待事件:
import { on, EventEmitter } from 'node:events';
import process from 'node:process';
const ac = new AbortController();
(async () => {
const ee = new EventEmitter();
// Emit later on
process.nextTick(() => {
ee.emit('foo', 'bar');
ee.emit('foo', 42);
});
for await (const event of on(ee, 'foo', { signal: ac.signal })) {
// The execution of this inner block is synchronous and it
// processes one event at a time (even with await). Do not use
// if concurrent execution is required.
console.log(event); // prints ['bar'] [42]
}
// Unreachable here
})();
process.nextTick(() => ac.abort());
The name of the event being listened for
Optional
options: StaticEventEmitterOptionsthat iterates eventName
events emitted by the emitter
v13.6.0, v12.16.0
Static
onceCreates a 创建一个Promise
that is fulfilled when the EventEmitter
emits the given event or that is rejected if the EventEmitter
emits 'error'
while waiting.Promise
,该Promise在EventEmitter
发出给定事件时实现,或者如果EventEmitter
在等待时发出“error”则被拒绝。
The Promise
will resolve with an array of all the arguments emitted to the given event.Promise
将通过向给定事件发出的所有参数的数组进行解析。
This method is intentionally generic and works with the web platform EventTarget interface, which has no special此方法是有意通用的,可与web平台EventTarget接口配合使用,该接口没有特殊的'error'
event semantics and does not listen to the 'error'
event.'error'
事件语义,也不侦听'error'
消息。
import { once, EventEmitter } from 'node:events';
import process from 'node:process';
const ee = new EventEmitter();
process.nextTick(() => {
ee.emit('myevent', 42);
});
const [value] = await once(ee, 'myevent');
console.log(value);
const err = new Error('kaboom');
process.nextTick(() => {
ee.emit('error', err);
});
try {
await once(ee, 'myevent');
} catch (err) {
console.error('error happened', err);
}
The special handling of the 'error'
event is only used when events.once()
is used to wait for another event. 'error'
事件的特殊处理仅在events.once()
用于等待另一个事件时使用。If 如果events.once()
is used to wait for the 'error'
event itself, then it is treated as any other kind of event without special handling:events.once()
用于等待'error'
事件本身,那么它将被视为任何其他类型的事件,而无需特殊处理:
import { EventEmitter, once } from 'node:events';
const ee = new EventEmitter();
once(ee, 'error')
.then(([err]) => console.log('ok', err.message))
.catch((err) => console.error('error', err.message));
ee.emit('error', new Error('boom'));
// Prints: ok boom
An AbortSignal
can be used to cancel waiting for the event:AbortSignal
可用于取消等待事件:
import { EventEmitter, once } from 'node:events';
const ee = new EventEmitter();
const ac = new AbortController();
async function foo(emitter, event, signal) {
try {
await once(emitter, event, { signal });
console.log('event emitted!');
} catch (error) {
if (error.name === 'AbortError') {
console.error('Waiting for the event was canceled!');
} else {
console.error('There was an error', error.message);
}
}
}
foo(ee, 'foo', ac.signal);
ac.abort(); // Abort waiting for the event
ee.emit('foo'); // Prints: Waiting for the event was canceled!打印:等待活动已取消!
Optional
options: StaticEventEmitterOptionsv11.13.0, v10.16.0
Optional
options: StaticEventEmitterOptionsStatic
setimport { setMaxListeners, EventEmitter } from 'node:events';
const target = new EventTarget();
const emitter = new EventEmitter();
setMaxListeners(5, target, emitter);
Optional
n: numberA non-negative number. The maximum number of listeners per 一个非负数。每个EventTarget
event.EventTarget
事件的最大侦听器数。
Rest
...eventTargets: (EventEmitter | _DOMEventTarget)[]v15.4.0
Generated using TypeDoc
Creates a new Change Stream instance.创建一个新的变更流实例。Normally created using通常使用Collection.watch()
.Collection.watch()
创建。