Node.js v18.6.0 文档

目录

events 事件触发器#

中英对照

稳定性: 2 - 稳定

源代码: lib/events.js

Node.js 的大部分核心 API 都是围绕惯用的异步事件驱动架构构建的，在该架构中，某些类型的对象（称为"触发器"）触发命名事件，使 Function 对象（"监听器"）被调用。

例如：net.Server 对象在每次有连接时触发事件；fs.ReadStream 在打开文件时触发事件；流在每当有数据可供读取时触发事件。

所有触发事件的对象都是 EventEmitter 类的实例。 这些对象暴露了 eventEmitter.on() 函数，允许将一个或多个函数绑定到对象触发的命名事件。 通常，事件名称是驼峰式字符串，但也可以使用任何有效的 JavaScript 属性键。

当 EventEmitter 对象触发事件时，所有绑定到该特定事件的函数都会被同步地调用。 被调用的监听器返回的任何值都将被忽略和丢弃。

以下示例展示了使用单个监听器的简单的 EventEmitter 实例。 eventEmitter.on() 方法用于注册监听器，eventEmitter.emit() 方法用于触发事件。

import { EventEmitter } from 'node:events';

class MyEmitter extends EventEmitter {}

const myEmitter = new MyEmitter();
myEmitter.on('event', () => {
  console.log('an event occurred!');
});
myEmitter.emit('event');const EventEmitter = require('node:events');

class MyEmitter extends EventEmitter {}

const myEmitter = new MyEmitter();
myEmitter.on('event', () => {
  console.log('an event occurred!');
});
myEmitter.emit('event');

将参数和 this 传给监听器#

中英对照

eventEmitter.emit() 方法允许将任意一组参数传给监听器函数。 记住，当调用普通的监听器函数时，标准的 this 关键字会被有意地设置为引用监听器绑定到的 EventEmitter 实例。

const myEmitter = new MyEmitter();
myEmitter.on('event', function(a, b) {
  console.log(a, b, this, this === myEmitter);
  // 打印:
  //   a b MyEmitter {
  //     domain: null,
  //     _events: { event: [Function] },
  //     _eventsCount: 1,
  //     _maxListeners: undefined } true
});
myEmitter.emit('event', 'a', 'b');

可以使用 ES6 箭头函数作为监听器，但是，这样做时，this 关键字将不再引用 EventEmitter 实例：

const myEmitter = new MyEmitter();
myEmitter.on('event', (a, b) => {
  console.log(a, b, this);
  // 打印: a b {}
});
myEmitter.emit('event', 'a', 'b');

异步 VS 同步#

中英对照

EventEmitter 按照注册的顺序同步地调用所有监听器。 这确保了事件的正确排序，并有助于避免竞争条件和逻辑错误。 在适当的时候，监听器函数可以使用 setImmediate() 或 process.nextTick() 方法切换到异步的操作模式：

const myEmitter = new MyEmitter();
myEmitter.on('event', (a, b) => {
  setImmediate(() => {
    console.log('this happens asynchronously');
  });
});
myEmitter.emit('event', 'a', 'b');

仅处理事件一次#

中英对照

当使用 eventEmitter.on() 方法注册监听器时，每次触发命名事件时都会调用该监听器。

const myEmitter = new MyEmitter();
let m = 0;
myEmitter.on('event', () => {
  console.log(++m);
});
myEmitter.emit('event');
// 打印: 1
myEmitter.emit('event');
// 打印: 2

使用 eventEmitter.once() 方法，可以注册一个监听器，该监听器最多为特定事件调用一次。 一旦事件被触发，则监听器就会被注销然后被调用。

const myEmitter = new MyEmitter();
let m = 0;
myEmitter.once('event', () => {
  console.log(++m);
});
myEmitter.emit('event');
// 打印: 1
myEmitter.emit('event');
// 忽略

错误事件#

中英对照

当 EventEmitter 实例中发生错误时，典型的操作是触发 'error' 事件。 这些在 Node.js 中被视为特殊情况。

如果 EventEmitter 没有为 'error' 事件注册至少一个监听器，并且触发 'error' 事件，则会抛出错误，打印堆栈跟踪，然后退出 Node.js 进程。

const myEmitter = new MyEmitter();
myEmitter.emit('error', new Error('whoops!'));
// 抛出错误并使 Node.js 崩溃

为了防止 Node.js 进程崩溃，可以使用 domain 模块。 （但请注意，不推荐使用 node:domain 模块。）

作为最佳实践，应始终为 'error' 事件添加监听器。

const myEmitter = new MyEmitter();
myEmitter.on('error', (err) => {
  console.error('whoops! there was an error');
});
myEmitter.emit('error', new Error('whoops!'));
// 打印: whoops! there was an error

通过使用符号 events.errorMonitor 安装监听器，可以在不消费触发的错误的情况下监视 'error' 事件。

import { EventEmitter, errorMonitor } from 'node:events';

const myEmitter = new EventEmitter();
myEmitter.on(errorMonitor, (err) => {
  MyMonitoringTool.log(err);
});
myEmitter.emit('error', new Error('whoops!'));
// 仍然抛出错误并使 Node.js 崩溃const { EventEmitter, errorMonitor } = require('node:events');

const myEmitter = new EventEmitter();
myEmitter.on(errorMonitor, (err) => {
  MyMonitoringTool.log(err);
});
myEmitter.emit('error', new Error('whoops!'));
// 仍然抛出错误并使 Node.js 崩溃

捕捉 Promise 拒绝#

中英对照

将 async 函数与事件句柄一起使用是有问题的，因为它会在抛出异常的情况下导致未处理的拒绝：

const ee = new EventEmitter();
ee.on('something', async (value) => {
  throw new Error('kaboom');
});

EventEmitter 构造函数中的 captureRejections 选项或全局的设置可以改变这种行为，在 Promise 上安装 .then(undefined, handler) 句柄。 此句柄将异常异步地路由到 Symbol.for('nodejs.rejection') 方法（如果有）或 'error' 事件句柄（如果没有）。

const ee1 = new EventEmitter({ captureRejections: true });
ee1.on('something', async (value) => {
  throw new Error('kaboom');
});

ee1.on('error', console.log);

const ee2 = new EventEmitter({ captureRejections: true });
ee2.on('something', async (value) => {
  throw new Error('kaboom');
});

ee2[Symbol.for('nodejs.rejection')] = console.log;

设置 events.captureRejections = true 将更改 EventEmitter 的所有新实例的默认值。

import { EventEmitter } from 'node:events';

EventEmitter.captureRejections = true;
const ee1 = new EventEmitter();
ee1.on('something', async (value) => {
  throw new Error('kaboom');
});

ee1.on('error', console.log);const events = require('node:events');
events.captureRejections = true;
const ee1 = new events.EventEmitter();
ee1.on('something', async (value) => {
  throw new Error('kaboom');
});

ee1.on('error', console.log);

由 captureRejections 行为生成的 'error' 事件没有捕获句柄以避免无限的错误循环：建议不要使用 async 函数作为 'error' 事件句柄。

EventEmitter 类#

中英对照

版本历史
版本变更
v13.4.0, v12.16.0

添加了捕获拒绝的选项。

v0.1.26

新增于: v0.1.26

EventEmitter 类由 node:events 模块定义和暴露：

import { EventEmitter } from 'node:events';const EventEmitter = require('node:events');

所有的 EventEmitter，当添加新的监听器时触发事件 'newListener'，当删除现有的监听器时触发事件 'removeListener'。

它支持以下的选项：

'newListener' 事件#

中英对照

新增于: v0.1.26

在将监听器添加到其内部监听器数组之前，EventEmitter 实例将触发自身的 'newListener' 事件。

为 'newListener' 事件注册的监听器会传入事件名称和对正在添加的监听器的引用。

在添加监听器之前触发事件这一事实有一个微妙但重要的副作用：在 'newListener' 回调中注册到同一个 name 的任何其他监听器都会在正在添加的监听器之前插入。

class MyEmitter extends EventEmitter {}

const myEmitter = new MyEmitter();
// 只做一次，这样就不会永远循环
myEmitter.once('newListener', (event, listener) => {
  if (event === 'event') {
    // 在前面插入新的监听器
    myEmitter.on('event', () => {
      console.log('B');
    });
  }
});
myEmitter.on('event', () => {
  console.log('A');
});
myEmitter.emit('event');
// 打印:
//   B
//   A

'removeListener' 事件#

中英对照

版本历史
版本变更
v6.1.0, v4.7.0

对于使用 .once() 绑定的监听器，listener 参数现在生成原始的监听器函数。

v0.9.3

新增于: v0.9.3

在移除 listener 后触发 'removeListener' 事件。

emitter.addListener(eventName, listener)#

中英对照

新增于: v0.1.26

emitter.on(eventName, listener) 的别名。

emitter.emit(eventName[, ...args])#

中英对照

新增于: v0.1.26

按注册顺序同步地调用为名为 eventName 的事件注册的每个监听器，并将提供的参数传给每个监听器。

如果事件有监听器，则返回 true，否则返回 false。

import { EventEmitter } from 'node:events';
const myEmitter = new EventEmitter();

// 第一个监听器
myEmitter.on('event', function firstListener() {
  console.log('Helloooo! first listener');
});
// 第二个监听器
myEmitter.on('event', function secondListener(arg1, arg2) {
  console.log(`event with parameters ${arg1}, ${arg2} in second 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);

// 打印:
// [
//   [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 listenerconst EventEmitter = require('node:events');
const myEmitter = new EventEmitter();

// 第一个监听器
myEmitter.on('event', function firstListener() {
  console.log('Helloooo! first listener');
});
// 第二个监听器
myEmitter.on('event', function secondListener(arg1, arg2) {
  console.log(`event with parameters ${arg1}, ${arg2} in second 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);

// 打印:
// [
//   [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

emitter.eventNames()#

中英对照

新增于: v6.0.0

返回列出触发器已为其注册监听器的事件的数组。 数组中的值是字符串或 Symbol。

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());
// 打印: [ 'foo', 'bar', Symbol(symbol) ]const EventEmitter = require('node:events');

const myEE = new EventEmitter();
myEE.on('foo', () => {});
myEE.on('bar', () => {});

const sym = Symbol('symbol');
myEE.on(sym, () => {});

console.log(myEE.eventNames());
// 打印: [ 'foo', 'bar', Symbol(symbol) ]

emitter.getMaxListeners()#

中英对照

新增于: v1.0.0

返回 EventEmitter 的当前最大监听器数的值，该值由 emitter.setMaxListeners(n) 设置或默认为 events.defaultMaxListeners。

emitter.listenerCount(eventName)#

中英对照

新增于: v3.2.0

返回监听名为 eventName 的事件的监听器数量。

emitter.listeners(eventName)#

中英对照

版本历史
版本变更
v7.0.0

对于使用 .once() 绑定的监听器，现在返回原始监听器而不是封装函数。

v0.1.26

新增于: v0.1.26

返回名为 eventName 的事件的监听器数组的副本。

server.on('connection', (stream) => {
  console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
// 打印: [ [Function] ]

emitter.off(eventName, listener)#

中英对照

新增于: v10.0.0

emitter.removeListener() 的别名。

emitter.on(eventName, listener)#

中英对照

新增于: v0.1.101

将 listener 函数添加到名为 eventName 的事件的监听器数组的末尾。 不检查是否已添加 listener。 多次调用传入相同的 eventName 和 listener 组合将导致多次添加和调用 listener。

server.on('connection', (stream) => {
  console.log('someone connected!');
});

返回对 EventEmitter 的引用，以便可以链式调用。

默认情况下，事件监听器按添加顺序调用。 emitter.prependListener() 方法可用作将事件监听器添加到监听器数组开头的替代方法。

const myEE = new EventEmitter();
myEE.on('foo', () => console.log('a'));
myEE.prependListener('foo', () => console.log('b'));
myEE.emit('foo');
// 打印:
//   b
//   a

emitter.once(eventName, listener)#

中英对照

新增于: v0.3.0

为名为 eventName 的事件添加单次的 listener 函数。 下次触发 eventName 时，将移除此监听器，然后再调用。

server.once('connection', (stream) => {
  console.log('Ah, we have our first user!');
});

返回对 EventEmitter 的引用，以便可以链式调用。

默认情况下，事件监听器按添加顺序调用。 emitter.prependOnceListener() 方法可用作将事件监听器添加到监听器数组开头的替代方法。

const myEE = new EventEmitter();
myEE.once('foo', () => console.log('a'));
myEE.prependOnceListener('foo', () => console.log('b'));
myEE.emit('foo');
// 打印:
//   b
//   a

emitter.prependListener(eventName, listener)#

中英对照

新增于: v6.0.0

将 listener 函数添加到名为 eventName 的事件的监听器数组的开头。 不检查是否已添加 listener。 多次调用传入相同的 eventName 和 listener 组合将导致多次添加和调用 listener。

server.prependListener('connection', (stream) => {
  console.log('someone connected!');
});

返回对 EventEmitter 的引用，以便可以链式调用。

emitter.prependOnceListener(eventName, listener)#

中英对照

新增于: v6.0.0

将名为 eventName 的事件的单次 listener 函数添加到监听器数组的开头。 下次触发 eventName 时，将移除此监听器，然后再调用。

server.prependOnceListener('connection', (stream) => {
  console.log('Ah, we have our first user!');
});

返回对 EventEmitter 的引用，以便可以链式调用。

emitter.removeAllListeners([eventName])#

中英对照

新增于: v0.1.26

删除所有监听器，或指定 eventName 的监听器。

删除在代码其他地方添加的监听器是不好的做法，特别是当 EventEmitter 实例是由其他组件或模块（例如套接字或文件流）创建时。

返回对 EventEmitter 的引用，以便可以链式调用。

emitter.removeListener(eventName, listener)#

中英对照

新增于: v0.1.26

从名为 eventName 的事件的监听器数组中移除指定的 listener。

const callback = (stream) => {
  console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);

removeListener() 最多从监听器数组中删除一个监听器实例。 如果任何单个监听器已多次添加到指定 eventName 的监听器数组中，则必须多次调用 removeListener() 以删除每个实例。

一旦事件被触发，则所有在触发时绑定到它的监听器都会被依次调用。 这意味着在触发之后和最后一个监听器完成执行之前的任何 removeListener() 或 removeAllListeners() 调用都不会从正在进行的 emit() 中删除它们。 后续事件按预期运行。

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 删除监听器 callbackB，但它仍将被调用。
// 触发时的内部监听器数组 [callbackA, callbackB]
myEmitter.emit('event');
// 打印:
//   A
//   B

// callbackB 现在被删除了。
// 内部监听器数组 [callbackA]
myEmitter.emit('event');
// 打印:
//   A

由于使用内部数组管理监听器，因此调用此方法将更改在移除监听器后注册的任何监听器的位置索引。 这不会影响调用监听器的顺序，但这意味着需要重新创建 emitter.listeners() 方法返回的监听器数组的任何副本。

当单个函数被多次添加为单个事件的句柄时（如下例所示），则 removeListener() 将删除最近添加的实例。 在示例中，删除了 once('ping') 监听器：

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');

返回对 EventEmitter 的引用，以便可以链式调用。

emitter.setMaxListeners(n)#

中英对照

新增于: v0.3.5

默认情况下，如果为特定事件添加了 10 个以上的监听器，则 EventEmitter 将打印警告。 这是一个有用的默认值，有助于查找内存泄漏。 emitter.setMaxListeners() 方法允许修改此特定 EventEmitter 实例的限制。 该值可以设置为 Infinity（或 0）以指示无限数量的监听器。

返回对 EventEmitter 的引用，以便可以链式调用。

emitter.rawListeners(eventName)#

中英对照

新增于: v9.4.0

返回名为 eventName 的事件的监听器数组的副本，包括任何封装器（例如由 .once() 创建的封装器）。

const emitter = new EventEmitter();
emitter.once('log', () => console.log('log once'));

// 返回具有函数 `onceWrapper` 的新数组，
// 该函数具有属性 `listener`，其中包含上面绑定的原始监听器
const listeners = emitter.rawListeners('log');
const logFnWrapper = listeners[0];

// 将"log once"记录到控制台并且不会解除 `once` 事件的绑定
logFnWrapper.listener();

// 将"log once"记录到控制台并删除监听器
logFnWrapper();

emitter.on('log', () => console.log('log persistently'));
// 将返回新数组，其中包含由上面的 `.on()` 绑定的函数
const newListeners = emitter.rawListeners('log');

// 记录"log persistently"两次
newListeners[0]();
emitter.emit('log');

emitter[Symbol.for('nodejs.rejection')](err, eventName[, ...args])#

中英对照

版本历史
版本变更
v17.4.0, v16.14.0

不再是实验的。

v13.4.0, v12.16.0

新增于: v13.4.0, v12.16.0

Symbol.for('nodejs.rejection') 方法被调用，以防在触发事件时发生 promise 拒绝，并且在触发器上启用了 captureRejections。 可以使用 events.captureRejectionSymbol 代替 Symbol.for('nodejs.rejection')。

import { EventEmitter, captureRejectionSymbol } from 'node:events';

class MyClass extends EventEmitter {
  constructor() {
    super({ captureRejections: true });
  }

  [captureRejectionSymbol](err, event, ...args) {
    console.log('rejection happened for', event, 'with', err, ...args);
    this.destroy(err);
  }

  destroy(err) {
    // 把这里的资源卸除。
  }
}const { EventEmitter, captureRejectionSymbol } = require('node:events');

class MyClass extends EventEmitter {
  constructor() {
    super({ captureRejections: true });
  }

  [captureRejectionSymbol](err, event, ...args) {
    console.log('rejection happened for', event, 'with', err, ...args);
    this.destroy(err);
  }

  destroy(err) {
    // 把这里的资源卸除。
  }
}

events.defaultMaxListeners#

中英对照

新增于: v0.11.2

默认情况下，最多可为任何单个事件注册 10 个监听器。 可以使用 emitter.setMaxListeners(n) 方法为单个 EventEmitter 实例更改此限制。 要更改所有 EventEmitter 实例的默认值，则可以使用 events.defaultMaxListeners 属性。 如果该值不是正数，则抛出 RangeError。

设置 events.defaultMaxListeners 时要小心，因为更改会影响所有 EventEmitter 实例，包括在进行更改之前创建的实例。 但是，调用 emitter.setMaxListeners(n) 仍然优先于 events.defaultMaxListeners。

这不是硬性限制。 EventEmitter 实例将允许添加更多监听器，但会向标准错误输出跟踪警告，指示已检测到"可能的 EventEmitter 内存泄漏"。 对于任何单个 EventEmitter，可以使用 emitter.getMaxListeners() 和 emitter.setMaxListeners() 方法来暂时避免此警告：

emitter.setMaxListeners(emitter.getMaxListeners() + 1);
emitter.once('event', () => {
  // 做些事情
  emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0));
});

--trace-warnings 命令行标志可用于显示此类警告的堆栈跟踪。

触发的警告可以使用 process.on('warning') 进行检查，并将具有额外的 emitter、type 和 count 属性，分别指事件触发器实例、事件名称和附加监听器的数量。 其 name 属性设置为 'MaxListenersExceededWarning'。

events.errorMonitor#

中英对照

新增于: v13.6.0, v12.17.0

此符号应用于安装仅监视 'error' 事件的监听器。 在调用常规 'error' 监听器之前调用使用此符号安装的监听器。

一旦触发 'error' 事件，则使用此符号安装监听器不会改变行为。 因此，如果没有安装常规的 'error' 监听器，则进程仍然会崩溃。

events.getEventListeners(emitterOrTarget, eventName)#

中英对照

新增于: v15.2.0, v14.17.0

返回名为 eventName 的事件的监听器数组的副本。

对于 EventEmitter，这与在触发器上调用 .listeners 的行为完全相同。

对于 EventTarget，这是获取事件目标的事件监听器的唯一方法。 这对于调试和诊断目的很有用。

import { getEventListeners, EventEmitter } from 'node: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]
}const { getEventListeners, EventEmitter } = require('node: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]
}

events.once(emitter, name[, options])#

中英对照

版本历史
版本变更
v15.0.0

现在支持 signal 选项。

v11.13.0, v10.16.0

新增于: v11.13.0, v10.16.0

创建 Promise，其在 EventEmitter 触发给定事件时被履行，或者如果 EventEmitter 在等待时触发 'error' 则被拒绝。 Promise 将使用触发给定事件的所有参数的数组解决。

此方法有意通用，与 Web 平台 EventTarget 接口配合使用，该接口没有特殊的 '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.log('error happened', err);
}const { once, EventEmitter } = require('node: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();

'error' 事件的特殊处理仅在 events.once() 用于等待另一个事件时使用。 如果 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.log('error', err.message));

ee.emit('error', new Error('boom'));

// 打印: ok boomconst { EventEmitter, once } = require('node: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'));

// 打印: ok boom

<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(); // 中止等待事件
ee.emit('foo'); // 打印: Waiting for the event was canceled!const { EventEmitter, once } = require('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(); // 中止等待事件
ee.emit('foo'); // 打印: Waiting for the event was canceled!

等待 process.nextTick() 上触发的多个事件#

中英对照

当使用 events.once() 函数等待在同一批 process.nextTick() 操作中触发的多个事件时，或者同步触发多个事件时，有一个边缘情况值得注意。 具体来说，因为 process.nextTick() 队列在 Promise 微任务队列之前被排空，并且因为 EventEmitter 同步触发所有事件，所以 events.once() 有可能错过事件。

import { EventEmitter, once } from 'node:events';
import process from 'node:process';

const myEE = new EventEmitter();

async function foo() {
  await once(myEE, 'bar');
  console.log('bar');

  // 此 Promise 永远不会被解决，
  // 因为 'foo' 事件在 Promise 被创建之前就已经触发了。
  await once(myEE, 'foo');
  console.log('foo');
}

process.nextTick(() => {
  myEE.emit('bar');
  myEE.emit('foo');
});

foo().then(() => console.log('done'));const { EventEmitter, once } = require('node:events');

const myEE = new EventEmitter();

async function foo() {
  await once(myEE, 'bar');
  console.log('bar');

  // 此 Promise 永远不会被解决，
  // 因为 'foo' 事件在 Promise 被创建之前就已经触发了。
  await once(myEE, 'foo');
  console.log('foo');
}

process.nextTick(() => {
  myEE.emit('bar');
  myEE.emit('foo');
});

foo().then(() => console.log('done'));

要捕获这两个事件，则在等待其中一个之前创建每个 Promise，然后可以使用 Promise.all()、Promise.race() 或 Promise.allSettled()：

import { EventEmitter, once } from 'node:events';
import process from 'node:process';

const myEE = new EventEmitter();

async function foo() {
  await Promise.all([once(myEE, 'bar'), once(myEE, 'foo')]);
  console.log('foo', 'bar');
}

process.nextTick(() => {
  myEE.emit('bar');
  myEE.emit('foo');
});

foo().then(() => console.log('done'));const { EventEmitter, once } = require('node:events');

const myEE = new EventEmitter();

async function foo() {
  await Promise.all([once(myEE, 'bar'), once(myEE, 'foo')]);
  console.log('foo', 'bar');
}

process.nextTick(() => {
  myEE.emit('bar');
  myEE.emit('foo');
});

foo().then(() => console.log('done'));

events.captureRejections#

中英对照

版本历史
版本变更
v17.4.0, v16.14.0

不再是实验的。

v13.4.0, v12.16.0

新增于: v13.4.0, v12.16.0

值: <boolean>

更改所有新的 EventEmitter 对象的默认 captureRejections 选项。

events.captureRejectionSymbol#

中英对照

版本历史
版本变更
v17.4.0, v16.14.0

不再是实验的。

v13.4.0, v12.16.0

新增于: v13.4.0, v12.16.0

值: Symbol.for('nodejs.rejection')

了解如何编写自定义的拒绝句柄。

events.listenerCount(emitter, eventName)#

中英对照

新增于: v0.9.12弃用于: v3.2.0

稳定性: 0 - 弃用: 改为使用 emitter.listenerCount() 。

返回在给定 emitter 上注册的给定 eventName 的监听器数量的类方法。

import { EventEmitter, listenerCount } from 'node:events';

const myEmitter = new EventEmitter();
myEmitter.on('event', () => {});
myEmitter.on('event', () => {});
console.log(listenerCount(myEmitter, 'event'));
// 打印: 2const { EventEmitter, listenerCount } = require('node:events');

const myEmitter = new EventEmitter();
myEmitter.on('event', () => {});
myEmitter.on('event', () => {});
console.log(listenerCount(myEmitter, 'event'));
// 打印: 2

events.on(emitter, eventName[, options])#

中英对照

新增于: v13.6.0, v12.16.0 
import { on, EventEmitter } from 'node:events';
import process from 'node:process';

const ee = new EventEmitter();

// 稍后触发
process.nextTick(() => {
  ee.emit('foo', 'bar');
  ee.emit('foo', 42);
});

for await (const event of on(ee, 'foo')) {
  // 此内部块的执行是同步的，
  // 它一次处理一个事件（即使有等待）。
  // 如果需要并发执行，则不要使用。
  console.log(event); // 打印 ['bar'] [42]
}
// 此处无法到达const { on, EventEmitter } = require('node:events');

(async () => {
  const ee = new EventEmitter();

  // 稍后触发
  process.nextTick(() => {
    ee.emit('foo', 'bar');
    ee.emit('foo', 42);
  });

  for await (const event of on(ee, 'foo')) {
    // 此内部块的执行是同步的，
    // 且每次处理一个事件（即使有等待）。
    // 如果需要并发执行，则不要使用。
    console.log(event); // 打印 ['bar'] [42]
  }
  // 此处无法到达
})();

返回迭代 eventName 事件的 AsyncIterator。 如果 EventEmitter 触发 'error'，则将抛出错误。 它在退出循环时删除所有监听器。 每次迭代返回的 value 是由触发的事件参数组成的数组。

<AbortSignal> 可用于取消对事件的等待：

import { on, EventEmitter } from 'node:events';
import process from 'node:process';

const ac = new AbortController();

(async () => {
  const ee = new EventEmitter();

  // 稍后触发
  process.nextTick(() => {
    ee.emit('foo', 'bar');
    ee.emit('foo', 42);
  });

  for await (const event of on(ee, 'foo', { signal: ac.signal })) {
    // 此内部块的执行是同步的，
    // 且每次处理一个事件（即使有等待）。
    // 如果需要并发执行，则不要使用。
    console.log(event); // 打印 ['bar'] [42]
  }
  // 此处无法到达
})();

process.nextTick(() => ac.abort());const { on, EventEmitter } = require('node:events');

const ac = new AbortController();

(async () => {
  const ee = new EventEmitter();

  // 稍后触发
  process.nextTick(() => {
    ee.emit('foo', 'bar');
    ee.emit('foo', 42);
  });

  for await (const event of on(ee, 'foo', { signal: ac.signal })) {
    // 此内部块的执行是同步的，
    // 且每次处理一个事件（即使有等待）。
    // 如果需要并发执行，则不要使用。
    console.log(event); // 打印 ['bar'] [42]
  }
  // 此处无法到达
})();

process.nextTick(() => ac.abort());

events.setMaxListeners(n[, ...eventTargets])#

中英对照

新增于: v15.4.0 
import { setMaxListeners, EventEmitter } from 'node:events';

const target = new EventTarget();
const emitter = new EventEmitter();

setMaxListeners(5, target, emitter);const {
  setMaxListeners,
  EventEmitter
} = require('node:events');

const target = new EventTarget();
const emitter = new EventEmitter();

setMaxListeners(5, target, emitter);

events.EventEmitterAsyncResource 类继承 EventEmitter 类#

中英对照

新增于: v17.4.0, v16.14.0

为需要手动异步跟踪的 EventEmitter 集成 EventEmitter 和 <AsyncResource>。 具体来说，events.EventEmitterAsyncResource 实例触发的所有事件都将在其异步上下文中运行。

import { EventEmitterAsyncResource } from 'node:events';
import { notStrictEqual, strictEqual } from 'node:assert';
import { executionAsyncId } from 'node:async_hooks';

// 异步跟踪工具会将其识别为 'Q'。
const ee1 = new EventEmitterAsyncResource({ name: 'Q' });

// 'foo' 监听器将在 EventEmitter 异步上下文中运行。
ee1.on('foo', () => {
  strictEqual(executionAsyncId(), ee1.asyncId);
  strictEqual(triggerAsyncId(), ee1.triggerAsyncId);
});

const ee2 = new EventEmitter();

// 普通 EventEmitter 上的 'foo' 监听器不跟踪异步上下文，
// 但是，在与 emit() 相同的异步上下文中运行。
ee2.on('foo', () => {
  notStrictEqual(executionAsyncId(), ee2.asyncId);
  notStrictEqual(triggerAsyncId(), ee2.triggerAsyncId);
});

Promise.resolve().then(() => {
  ee1.emit('foo');
  ee2.emit('foo');
});const { EventEmitterAsyncResource } = require('node:events');
const { notStrictEqual, strictEqual } = require('node:assert');
const { executionAsyncId } = require('node:async_hooks');

// 异步跟踪工具会将其识别为 'Q'。
const ee1 = new EventEmitterAsyncResource({ name: 'Q' });

// 'foo' 监听器将在 EventEmitter 异步上下文中运行。
ee1.on('foo', () => {
  strictEqual(executionAsyncId(), ee1.asyncId);
  strictEqual(triggerAsyncId(), ee1.triggerAsyncId);
});

const ee2 = new EventEmitter();

// 普通 EventEmitter 上的 'foo' 监听器不跟踪异步上下文，
// 但是，在与 emit() 相同的异步上下文中运行。
ee2.on('foo', () => {
  notStrictEqual(executionAsyncId(), ee2.asyncId);
  notStrictEqual(triggerAsyncId(), ee2.triggerAsyncId);
});

Promise.resolve().then(() => {
  ee1.emit('foo');
  ee2.emit('foo');
});

EventEmitterAsyncResource 类具有与 EventEmitter 和 AsyncResource 本身相同的方法和选项。

new events.EventEmitterAsyncResource(options)#

中英对照

  • options <Object>
    • captureRejections <boolean> 启用自动捕获 promise 拒绝。 默认值: false。
    • name <string> 异步事件的类型。 默认值:: new.target.name。
    • triggerAsyncId <number> 创建此异步事件的执行上下文的 ID。 默认值: executionAsyncId()。
    • requireManualDestroy <boolean> 如果设置为 true，则当对象被垃圾回收时禁用 emitDestroy。 这通常不需要设置（即使手动调用 emitDestroy），除非检索到资源的 asyncId 并调用敏感 API 的 emitDestroy。 当设置为 false 时，则只有在至少有一个活动的 destroy 钩子时才会调用 emitDestroy 垃圾回收。 默认值: false。

eventemitterasyncresource.asyncId#

中英对照

  • 类型: <number> 分配给资源的唯一 asyncId。

eventemitterasyncresource.asyncResource#

中英对照

返回的 AsyncResource 对象具有额外的 eventEmitter 属性，提供对此 EventEmitterAsyncResource 的引用。

eventemitterasyncresource.emitDestroy()#

中英对照

调用所有的 destroy 钩子。 这应该只被调用一次。 如果多次调用，则会报错。 这个必须手动调用。 如果资源留给 GC 收集，则永远不会调用 destroy 钩子。

eventemitterasyncresource.triggerAsyncId#

中英对照

  • 类型: <number> 传给 AsyncResource 构造函数的同一个 triggerAsyncId。

EventTarget 与 Event API#

中英对照

版本历史
版本变更
v16.0.0

更改了 EventTarget 的错误处理。

v15.4.0

不再是实验的。

v15.0.0

EventTarget 和 Event 类现在可用作全局变量。

v14.5.0

新增于: v14.5.0

EventTarget 和 Event 对象是一些 Node.js 核心 API 暴露的 EventTarget Web API 的特定于 Node.js 的实现。

const target = new EventTarget();

target.addEventListener('foo', (event) => {
  console.log('foo event happened!');
});

Node.js EventTarget 对比 DOM EventTarge#

中英对照

Node.js EventTarget 和 EventTarget Web API 之间有两个主要区别：

  1. 尽管 DOM EventTarget 实例可能是分层的，但 Node.js 中没有层次和事件传播的概念。 也就是说，调度到 EventTarget 的事件不会通过嵌套目标对象的层次结构传播，这些目标对象可能每个都有自己的事件句柄集。
  2. 在 Node.js EventTarget 中，如果事件监听器是异步的函数或者返回 Promise，并且返回的 Promise 拒绝，则该拒绝会被自动捕获并按照同步抛出的监听器的方式处理（详见 EventTarget 错误处理）。

NodeEventTarget 对比 EventEmitter#

中英对照

NodeEventTarget 对象实现了 EventEmitter API 的修改子集，允许它在某些情况下接近地模拟 EventEmitter。 NodeEventTarget 不是 EventEmitter 的实例，在大多数情况下不能代替 EventEmitter。

  1. 与 EventEmitter 不同，任何给定的 listener 最多可以在每个事件 type 中注册一次。 尝试多次注册 listener 将被忽略。
  2. NodeEventTarget 不模拟完整的 EventEmitter API。 特别是 prependListener()、prependOnceListener()、rawListeners()、setMaxListeners()、getMaxListeners() 和 errorMonitor API 没有被模拟。 'newListener' 和 'removeListener' 事件也不会触发。
  3. NodeEventTarget 没有为类型为 'error' 的事件实现任何特殊的默认行为。
  4. NodeEventTarget 支持 EventListener 对象以及作为所有事件类型句柄的函数。

事件监听器#

中英对照

为事件 type 注册的事件监听器可以是 JavaScript 函数，也可以是具有值为函数的 handleEvent 属性的对象。

在任何一种情况下，句柄函数都是通过传给 eventTarget.dispatchEvent() 函数的 event 参数调用的。

异步函数可用作事件监听器。 如果异步的句柄函数拒绝，则会按照 EventTarget 错误处理中的描述捕获和处理拒绝。

句柄函数抛出的错误不会阻止其他句柄被调用。

句柄函数的返回值会被忽略。

句柄始终按照其添加的顺序被调用。

句柄函数可能会改变 event 对象。

function handler1(event) {
  console.log(event.type);  // 打印 'foo'
  event.a = 1;
}

async function handler2(event) {
  console.log(event.type);  // 打印 'foo'
  console.log(event.a);  // 打印 1
}

const handler3 = {
  handleEvent(event) {
    console.log(event.type);  // 打印 'foo'
  }
};

const handler4 = {
  async handleEvent(event) {
    console.log(event.type);  // 打印 'foo'
  }
};

const target = new EventTarget();

target.addEventListener('foo', handler1);
target.addEventListener('foo', handler2);
target.addEventListener('foo', handler3);
target.addEventListener('foo', handler4, { once: true });

EventTarget 的错误处理#

中英对照

当注册的事件监听器抛出错误（或返回拒绝的 Promise）时，默认情况下，错误将被视为 process.nextTick() 上的未捕获异常。 这意味着 EventTarget 中未捕获的异常将默认终止 Node.js 进程。

在事件监听器中抛出错误不会阻止其他注册的句柄被调用。

EventTarget 没有为 'error' 类型的事件（如 EventEmitter）实现任何特殊的默认处理。

当前错误在到达 process.on('uncaughtException') 之前首先转发到 process.on('error') 事件。 此行为已弃用，并将在未来版本中更改，以使 EventTarget 与其他 Node.js API 保持一致。 任何依赖 process.on('error') 事件的代码都应与新行为保持一致。

Event 类#

中英对照

版本历史
版本变更
v15.0.0

Event 类现在可通过全局对象使用。

v14.5.0

新增于: v14.5.0

Event 对象是对 Event Web API 的改写。 实例由 Node.js 在内部创建。

event.bubbles#

中英对照

新增于: v14.5.0

这在 Node.js 中没有使用，纯粹是为了完整性而提供的。

event.cancelBubble()#

中英对照

新增于: v14.5.0

event.stopPropagation() 的别名。 这在 Node.js 中没有使用，纯粹是为了完整性而提供的。

event.cancelable#

中英对照

新增于: v14.5.0
  • 类型: <boolean> 如果事件是使用 cancelable 选项创建的，则为真。
event.composed#

中英对照

新增于: v14.5.0

这在 Node.js 中没有使用，纯粹是为了完整性而提供的。

event.composedPath()#

中英对照

新增于: v14.5.0

返回包含当前 EventTarget 作为唯一条目的数组，如果未调度事件则返回空数组。 这在 Node.js 中没有使用，纯粹是为了完整性而提供的。

event.currentTarget#

中英对照

新增于: v14.5.0

event.target 的别名。

event.defaultPrevented#

中英对照

新增于: v14.5.0

如果 cancelable 为 true 且 event.preventDefault() 已被调用，则为 true。

event.eventPhase#

中英对照

新增于: v14.5.0
  • 类型: <number> 事件未被调度时返回 0，事件被调度时返回 2。

这在 Node.js 中没有使用，纯粹是为了完整性而提供的。

event.isTrusted#

中英对照

新增于: v14.5.0

<AbortSignal> "abort" 事件是在 isTrusted 设置为 true 的情况下触发的。 在所有其他情况下，该值为 false。

event.preventDefault()#

中英对照

新增于: v14.5.0

如果 cancelable 是 true，则将 defaultPrevented 属性设置为 true。

event.returnValue#

中英对照

新增于: v14.5.0
  • 类型: <boolean> 如果事件尚未取消，则为真。

这在 Node.js 中没有使用，纯粹是为了完整性而提供的。

event.srcElement#

中英对照

新增于: v14.5.0

event.target 的别名。

event.stopImmediatePropagation()#

中英对照

新增于: v14.5.0

当前事件监听器完成后停止调用。

event.stopPropagation()#

中英对照

新增于: v14.5.0

这在 Node.js 中没有使用，纯粹是为了完整性而提供的。

event.target#

中英对照

新增于: v14.5.0
event.timeStamp#

中英对照

新增于: v14.5.0

创建 Event 对象时的毫秒时间戳。

event.type#

中英对照

新增于: v14.5.0

事件类型标识符。

EventTarget 类#

中英对照

版本历史
版本变更
v15.0.0

EventTarget 类现在可通过全局对象使用。

v14.5.0

新增于: v14.5.0

eventTarget.addEventListener(type, listener[, options])#

中英对照

版本历史
版本变更
v15.4.0

添加对 signal 选项的支持。

v14.5.0

新增于: v14.5.0

  • type <string>
  • listener <Function> | <EventListener>
  • options <Object>
    • once <boolean> 当为 true 时，监听器在第一次调用时自动移除。 默认值: false。
    • passive <boolean> 当为 true 时，提示监听器不会调用 Event 对象的 preventDefault() 方法。 默认值: false。
    • capture <boolean> Node.js 不直接使用。 为 API 完整性而添加。 默认值: false。
    • signal <AbortSignal> 当调用给定的 AbortSignal 对象的 abort() 方法时，则监听器将被移除。

为 type 事件添加新的句柄。 对于每个 type 和每个 capture 选项值，任何给定的 listener 仅添加一次。

如果 once 选项为 true，则在下一次调度 type 事件后移除 listener。

除了按照 EventTarget 规范跟踪注册的事件监听器之外，Node.js 不会以任何功能方式使用 capture 选项。 具体来说，capture 选项在注册 listener 时用作键的一部分。 任何单独的 listener 都可以与 capture = false 添加一次，与 capture = true 添加一次。

function handler(event) {}

const target = new EventTarget();
target.addEventListener('foo', handler, { capture: true });  // 第一次
target.addEventListener('foo', handler, { capture: false }); // 第二次

// 删除句柄的第二个实例
target.removeEventListener('foo', handler);

// 删除句柄的第一个实例
target.removeEventListener('foo', handler, { capture: true });
eventTarget.dispatchEvent(event)#

中英对照

新增于: v14.5.0
  • event <Event>
  • 返回: <boolean> 如果任一事件的 cancelable 属性值为 false 或其 preventDefault() 方法未调用，则为 true，否则为 false。

将 event 调度到 event.type 的句柄列表。

注册的事件监听器按照注册的顺序同步地调用。

eventTarget.removeEventListener(type, listener)#

中英对照

新增于: v14.5.0

从事件 type 的句柄列表中删除 listener。

NodeEventTarget 类#

中英对照

新增于: v14.5.0

NodeEventTarget 是 EventTarget 的 Node.js 特定扩展，它模拟了 EventEmitter API 的子集。

nodeEventTarget.addListener(type, listener[, options])#

中英对照

新增于: v14.5.0

EventTarget 类的 Node.js 特定扩展，可模拟等效的 EventEmitter API。 addListener() 和 addEventListener() 之间的唯一区别是 addListener() 将返回对 EventTarget 的引用。

nodeEventTarget.eventNames()#

中英对照

新增于: v14.5.0

Node.js 特定于 EventTarget 类的扩展，它返回事件 type 名称的数组，事件监听器注册了这些名称。

nodeEventTarget.listenerCount(type)#

中英对照

新增于: v14.5.0

EventTarget 类的 Node.js 特定扩展，返回为 type 注册的事件监听器的数量。

nodeEventTarget.off(type, listener)#

中英对照

新增于: v14.5.0

eventTarget.removeListener() 的 Node.js 特定别名。

nodeEventTarget.on(type, listener[, options])#

中英对照

新增于: v14.5.0

eventTarget.addListener() 的 Node.js 特定别名。

nodeEventTarget.once(type, listener[, options])#

中英对照

新增于: v14.5.0

EventTarget 类的 Node.js 特定扩展，它为给定的事件 type 添加了 once 监听器。 这相当于调用 on 并将 once 选项设置为 true。

nodeEventTarget.removeAllListeners([type])#

中英对照

新增于: v14.5.0

EventTarget 类的 Node.js 特定扩展。 如果指定了 type，则删除 type 的所有注册监听器，否则删除所有注册的监听器。

nodeEventTarget.removeListener(type, listener)#

中英对照

新增于: v14.5.0

Node.js 特定于 EventTarget 类的扩展，用于删除给定 type 的 listener。 removeListener() 和 removeEventListener() 之间的唯一区别是 removeListener() 将返回对 EventTarget 的引用。

返回顶部