Sets or gets the default captureRejection value for all emitters.设置或获取所有发射器的默认captureRejection值。
This symbol shall be used to install a listener for only monitoring 此符号应用于安装仅用于监视'error' events. 'error'事件的侦听器。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'侦听器，进程仍将崩溃。
The server id associated with this session与此会话关联的服务器id
Whether or not this session is configured for snapshot reads是否为快照读取配置此会话
Advances the clusterTime for a ClientSession to the provided clusterTime of another ClientSession将ClientSession的clusterTime提前到另一个ClientSessions的提供的clustrTime
the $clusterTime returned by the server from another session in the form of a document containing the 服务器从另一个会话以包含BSON.Timestamp clusterTime and signatureBSON.Timestamp clusterTime和签名的文档形式返回的$clusterName
Advances the operationTime for a ClientSession.提前ClientSession的操作时间。
the 希望前进到的操作类型的BSON.Timestamp of the operation type it is desired to advance toBSON.Timestamp
Ends this session on the server在服务器上结束此会话
Used to determine if this session equals another用于确定此会话是否等于另一个会话
The session to compare to要比较的会话
whether this session is currently in a transaction or not该会话当前是否处于事务中
Increment the transaction number on the internal ServerSession增加内部ServerSession上的事务编号
Starts a new transaction with the given options.
Options for the transaction事务的选项
This is here to ensure that ClientSession is never serialized to BSON.这是为了确保ClientSession永远不会序列化到BSON。
Runs a provided callback within a transaction, retrying either the commitTransaction operation or entire transaction as needed (and when the error permits) to better ensure that the transaction can complete successfully.在事务中运行提供的回调，根据需要（在错误允许的情况下）重试commitTransaction操作或整个事务，以更好地确保事务能够成功完成。
IMPORTANT: This method requires the user to return a Promise, and 此方法要求用户返回Promise，并await all operations. await所有操作。Any callbacks that do not return a Promise will result in undefined behavior.任何不返回Promise的回调都将导致未定义的行为。
callback to run within a transaction在事务中运行的回调
optional settings for the transaction事务的可选设置
A raw command response or undefined原始命令响应或未定义
Returns a copy of the array of listeners for the event named 返回名为eventName.eventName的事件的侦听器数组的副本。
For 对于EventEmitters this behaves exactly the same as calling .listeners on the emitter.EventEmitter，这与调用emitter上的.listeners完全相同。
For 对于EventTargets this is the only way to get the event listeners for the event target. EventTarget，这是获取事件目标的事件侦听器的唯一方法。This is useful for debugging and diagnostic purposes.这对于调试和诊断非常有用。
const { getEventListeners, EventEmitter } = require('events');
{
const ee = new EventEmitter();
const listener = () => console.log('Events are fun');
ee.on('foo', listener);
getEventListeners(ee, 'foo'); // [listener]
}
{
const et = new EventTarget();
const listener = () => console.log('Events are fun');
et.addEventListener('foo', listener);
getEventListeners(et, 'foo'); // [listener]
}A class method that returns the number of listeners for the given 返回在给定eventNameregistered on the given emitter.emitter上注册的给定eventName的侦听器数量的类方法。
const { EventEmitter, listenerCount } = require('events');
const myEmitter = new EventEmitter();
myEmitter.on('event', () => {});
myEmitter.on('event', () => {});
console.log(listenerCount(myEmitter, 'event'));
// Prints: 2The emitter to query要查询的发射器
The event name事件名称
const { on, EventEmitter } = require('events');
(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')) {
// 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可用于取消等待事件：
const { on, EventEmitter } = require('events');
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 useif concurrent execution is required.如果需要并发执行，请不要使用。
console.log(event); // prints ['bar'] [42]
}
// Unreachable here此处无法访问
})();
process.nextTick(() => ac.abort());The name of the event being listened for正在侦听的事件的名称
that iterates 迭代eventName events emitted by the emitteremitter发出的eventName事件
Creates a 创建一个Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. Promise，当EventEmitter发出给定事件时，该Promise将被满足，或者当EventEmitter在等待时发出'error'时，该Promise被拒绝。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'。
const { once, EventEmitter } = require('events');
async function run() {
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.log('error happened', err);
}
}
run();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'事件本身，则它将被视为任何其他类型的事件，无需特殊处理：
const { EventEmitter, once } = require('events');
const ee = new EventEmitter();
once(ee, 'error')
.then(([err]) => console.log('ok', err.message))
.catch((err) => console.log('error', err.message));
ee.emit('error', new Error('boom'));
// Prints: ok boomAn AbortSignal can be used to cancel waiting for the event:AbortSignal可用于取消等待事件：
const { EventEmitter, once } = require('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!const { setMaxListeners, EventEmitter } = require('events');
const target = new EventTarget();
const emitter = new EventEmitter();
setMaxListeners(5, target, emitter); A non-negative number. 非负数。The maximum number of listeners per 每个EventTarget event.EventTarget事件的最大侦听器数。
Generated using TypeDoc
A class representing a client session on the server表示服务器上客户端会话的类NOTE: not meant to be instantiated directly.注意：不打算直接实例化。