Node.js v20.7.0 文档

将参数和 this 传递给监听器#

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

import { EventEmitter } from 'node:events';
class MyEmitter extends EventEmitter {}
const myEmitter = new MyEmitter();
myEmitter.on('event', function(a, b) {
  console.log(a, b, this, this === myEmitter);
  // Prints:
  //   a b MyEmitter {
  //     _events: [Object: null prototype] { event: [Function (anonymous)] },
  //     _eventsCount: 1,
  //     _maxListeners: undefined,
  //     [Symbol(kCapture)]: false
  //   } true
});
myEmitter.emit('event', 'a', 'b');const EventEmitter = require('node:events');
class MyEmitter extends EventEmitter {}
const myEmitter = new MyEmitter();
myEmitter.on('event', function(a, b) {
  console.log(a, b, this, this === myEmitter);
  // Prints:
  //   a b MyEmitter {
  //     _events: [Object: null prototype] { event: [Function (anonymous)] },
  //     _eventsCount: 1,
  //     _maxListeners: undefined,
  //     [Symbol(kCapture)]: false
  //   } true
});
myEmitter.emit('event', 'a', 'b');拷贝

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

import { EventEmitter } from 'node:events';
class MyEmitter extends EventEmitter {}
const myEmitter = new MyEmitter();
myEmitter.on('event', (a, b) => {
  console.log(a, b, this);
  // Prints: a b {}
});
myEmitter.emit('event', 'a', 'b');const EventEmitter = require('node:events');
class MyEmitter extends EventEmitter {}
const myEmitter = new MyEmitter();
myEmitter.on('event', (a, b) => {
  console.log(a, b, this);
  // Prints: a b {}
});
myEmitter.emit('event', 'a', 'b');拷贝

异步与同步#

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

import { EventEmitter } from 'node:events';
class MyEmitter extends EventEmitter {}
const myEmitter = new MyEmitter();
myEmitter.on('event', (a, b) => {
  setImmediate(() => {
    console.log('this happens asynchronously');
  });
});
myEmitter.emit('event', 'a', 'b');const EventEmitter = require('node:events');
class MyEmitter extends EventEmitter {}
const myEmitter = new MyEmitter();
myEmitter.on('event', (a, b) => {
  setImmediate(() => {
    console.log('this happens asynchronously');
  });
});
myEmitter.emit('event', 'a', 'b');拷贝

只处理一次事件#

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

import { EventEmitter } from 'node:events';
class MyEmitter extends EventEmitter {}
const myEmitter = new MyEmitter();
let m = 0;
myEmitter.on('event', () => {
  console.log(++m);
});
myEmitter.emit('event');
// Prints: 1
myEmitter.emit('event');
// Prints: 2const EventEmitter = require('node:events');
class MyEmitter extends EventEmitter {}
const myEmitter = new MyEmitter();
let m = 0;
myEmitter.on('event', () => {
  console.log(++m);
});
myEmitter.emit('event');
// Prints: 1
myEmitter.emit('event');
// Prints: 2拷贝

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

import { EventEmitter } from 'node:events';
class MyEmitter extends EventEmitter {}
const myEmitter = new MyEmitter();
let m = 0;
myEmitter.once('event', () => {
  console.log(++m);
});
myEmitter.emit('event');
// Prints: 1
myEmitter.emit('event');
// Ignoredconst EventEmitter = require('node:events');
class MyEmitter extends EventEmitter {}
const myEmitter = new MyEmitter();
let m = 0;
myEmitter.once('event', () => {
  console.log(++m);
});
myEmitter.emit('event');
// Prints: 1
myEmitter.emit('event');
// Ignored拷贝

错误事件#

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

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

import { EventEmitter } from 'node:events';
class MyEmitter extends EventEmitter {}
const myEmitter = new MyEmitter();
myEmitter.emit('error', new Error('whoops!'));
// Throws and crashes Node.jsconst EventEmitter = require('node:events');
class MyEmitter extends EventEmitter {}
const myEmitter = new MyEmitter();
myEmitter.emit('error', new Error('whoops!'));
// Throws and crashes Node.js拷贝

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

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

import { EventEmitter } from 'node:events';
class MyEmitter extends EventEmitter {}
const myEmitter = new MyEmitter();
myEmitter.on('error', (err) => {
  console.error('whoops! there was an error');
});
myEmitter.emit('error', new Error('whoops!'));
// Prints: whoops! there was an errorconst EventEmitter = require('node:events');
class MyEmitter extends EventEmitter {}
const myEmitter = new MyEmitter();
myEmitter.on('error', (err) => {
  console.error('whoops! there was an error');
});
myEmitter.emit('error', new Error('whoops!'));
// Prints: 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!'));
// Still throws and crashes Node.jsconst { EventEmitter, errorMonitor } = require('node:events');

const myEmitter = new EventEmitter();
myEmitter.on(errorMonitor, (err) => {
  MyMonitoringTool.log(err);
});
myEmitter.emit('error', new Error('whoops!'));
// Still throws and crashes Node.js拷贝

捕获对 promise 的拒绝#

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

import { EventEmitter } from 'node:events';
const ee = new EventEmitter();
ee.on('something', async (value) => {
  throw new Error('kaboom');
});const EventEmitter = require('node:events');
const ee = new EventEmitter();
ee.on('something', async (value) => {
  throw new Error('kaboom');
});拷贝

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

import { EventEmitter } from 'node:events';
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;const EventEmitter = require('node:events');
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#

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

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

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

它支持以下的选项：

• captureRejections <boolean> 它启用 自动捕获 promise 拒绝。 默认值： false。

事件：'newListener'#

• eventName <string> | <symbol> 正在监听的事件的名称
• listener <Function> 事件处理函数

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

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

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

import { EventEmitter } from 'node:events';
class MyEmitter extends EventEmitter {}

const myEmitter = new MyEmitter();
// Only do this once so we don't loop forever
myEmitter.once('newListener', (event, listener) => {
  if (event === 'event') {
    // Insert a new listener in front
    myEmitter.on('event', () => {
      console.log('B');
    });
  }
});
myEmitter.on('event', () => {
  console.log('A');
});
myEmitter.emit('event');
// Prints:
//   B
//   Aconst EventEmitter = require('node:events');
class MyEmitter extends EventEmitter {}

const myEmitter = new MyEmitter();
// Only do this once so we don't loop forever
myEmitter.once('newListener', (event, listener) => {
  if (event === 'event') {
    // Insert a new listener in front
    myEmitter.on('event', () => {
      console.log('B');
    });
  }
});
myEmitter.on('event', () => {
  console.log('A');
});
myEmitter.emit('event');
// Prints:
//   B
//   A拷贝

事件：'removeListener'#

• eventName <string> | <symbol> 事件名称
• listener <Function> 事件处理函数

'removeListener' 事件在 listener 被删除后触发。

emitter.addListener(eventName, listener)#

• eventName <string> | <symbol>
• listener <Function>

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

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

• eventName <string> | <symbol>
• ...args <any>
• 返回： <boolean>

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

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

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 listenerconst EventEmitter = require('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拷贝

emitter.eventNames()#

• 返回： <Array>

返回列出触发器已为其注册监听器的事件的数组。 数组中的值是字符串或 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());
// Prints: [ '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());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]拷贝

emitter.getMaxListeners()#

• 返回： <integer>

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

emitter.listenerCount(eventName[, listener])#

• eventName <string> | <symbol> 正在监听的事件的名称
• listener <Function> 事件处理函数
• 返回： <integer>

返回监听名为 eventName 的事件的监听器数量。 如果提供了 listener，它将返回在事件的监听器列表中找到监听器的次数。

emitter.listeners(eventName)#

• eventName <string> | <symbol>
• 返回： <Function[]>

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

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

emitter.off(eventName, listener)#

• eventName <string> | <symbol>
• listener <Function>
• 返回： <EventEmitter>

emitter.removeListener() 的别名。

emitter.on(eventName, listener)#

• eventName <string> | <symbol> 事件的名称。
• listener <Function> 回调函数
• 返回： <EventEmitter>

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

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

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

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

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
//   aconst EventEmitter = require('node:events');
const myEE = new EventEmitter();
myEE.on('foo', () => console.log('a'));
myEE.prependListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a拷贝

emitter.once(eventName, listener)#

• eventName <string> | <symbol> 事件的名称。
• listener <Function> 回调函数
• 返回： <EventEmitter>

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

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

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

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

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
//   aconst EventEmitter = require('node:events');
const myEE = new EventEmitter();
myEE.once('foo', () => console.log('a'));
myEE.prependOnceListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a拷贝

emitter.prependListener(eventName, listener)#

• eventName <string> | <symbol> 事件的名称。
• listener <Function> 回调函数
• 返回： <EventEmitter>

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

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

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

emitter.prependOnceListener(eventName, listener)#

• eventName <string> | <symbol> 事件的名称。
• listener <Function> 回调函数
• 返回： <EventEmitter>

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

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

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

emitter.removeAllListeners([eventName])#

• eventName <string> | <symbol>
• 返回： <EventEmitter>

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

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

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

emitter.removeListener(eventName, listener)#

• eventName <string> | <symbol>
• listener <Function>
• 返回： <EventEmitter>

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

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

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

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

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:
//   Aconst EventEmitter = require('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拷贝

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

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

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');const EventEmitter = require('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');拷贝

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

emitter.setMaxListeners(n)#

• n <integer>
• 返回： <EventEmitter>

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

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

emitter.rawListeners(eventName)#

• eventName <string> | <symbol>
• 返回： <Function[]>

返回名为 eventName 的事件的监听器数组的副本，包括任何封装器（例如由 .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');const EventEmitter = require('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');拷贝

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

• err 错误
• eventName <string> | <symbol>
• ...args <any>

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) {
    // Tear the resource down here.
  }
}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) {
    // Tear the resource down here.
  }
}拷贝

events.defaultMaxListeners#

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

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

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

import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.setMaxListeners(emitter.getMaxListeners() + 1);
emitter.once('event', () => {
  // do stuff
  emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0));
});const EventEmitter = require('node:events');
const emitter = new EventEmitter();
emitter.setMaxListeners(emitter.getMaxListeners() + 1);
emitter.once('event', () => {
  // do stuff
  emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0));
});拷贝

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

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

events.errorMonitor#

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

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

events.getEventListeners(emitterOrTarget, eventName)#

• emitterOrTarget <EventEmitter> | <EventTarget>
• eventName <string> | <symbol>
• 返回： <Function[]>

返回名为 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);
  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] ]
}const { getEventListeners, EventEmitter } = require('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] ]
}拷贝

events.getMaxListeners(emitterOrTarget)#

• emitterOrTarget <EventEmitter> | <EventTarget>
• 返回： <number>

返回当前设置的最大监听器数量。

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

对于 EventTarget，这是为事件目标获取最大事件监听器的唯一方法。 如果单个 EventTarget 上的事件处理程序数量超过最大设置，EventTarget 将打印警告。

import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';

{
  const ee = new EventEmitter();
  console.log(getMaxListeners(ee)); // 10
  setMaxListeners(11, ee);
  console.log(getMaxListeners(ee)); // 11
}
{
  const et = new EventTarget();
  console.log(getMaxListeners(et)); // 10
  setMaxListeners(11, et);
  console.log(getMaxListeners(et)); // 11
}const { getMaxListeners, setMaxListeners, EventEmitter } = require('node:events');

{
  const ee = new EventEmitter();
  console.log(getMaxListeners(ee)); // 10
  setMaxListeners(11, ee);
  console.log(getMaxListeners(ee)); // 11
}
{
  const et = new EventTarget();
  console.log(getMaxListeners(et)); // 10
  setMaxListeners(11, et);
  console.log(getMaxListeners(et)); // 11
}拷贝

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

• emitter <EventEmitter>
• name <string>
• options <Object>
  • signal <AbortSignal> 可用于取消等待事件。
• 返回： <Promise>

创建 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.error('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.error('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.error('error', err.message));

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

// Prints: ok boomconst { EventEmitter, once } = require('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拷贝

<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!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(); // Abort waiting for the event
ee.emit('foo'); // Prints: 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');

  // This Promise will never resolve because the 'foo' event will
  // have already been emitted before the Promise is created.
  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');

  // This Promise will never resolve because the 'foo' event will
  // have already been emitted before the Promise is created.
  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#

值 <boolean>

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

events.captureRejectionSymbol#

值 Symbol.for('nodejs.rejection')

查看如何编写自定义 拒绝处理程序。

events.listenerCount(emitter, eventName)#

• emitter <EventEmitter> 要查询的触发器
• eventName <string> | <symbol> 事件名称

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

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

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

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

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

• emitter <EventEmitter>
• eventName <string> | <symbol> 正在监听的事件的名称
• options <Object>
  • signal <AbortSignal> 可用于取消等待事件。
• 返回： <AsyncIterator> 迭代由 emitter 触发的 eventName 事件

import { 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 hereconst { on, EventEmitter } = require('node: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
})();拷贝

返回迭代 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();

  // 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());const { on, EventEmitter } = require('node: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 use
    // if concurrent execution is required.
    console.log(event); // prints ['bar'] [42]
  }
  // Unreachable here
})();

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

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

• n <number> 非负的数值。 每个 EventTarget 事件的最大监听器数。
• ...eventsTargets <EventTarget[]> | <EventEmitter[]> 零个或多个 <EventTarget> 或 <EventEmitter> 实例。 如果没有指定，则 n 被设置为所有新创建的 <EventTarget> 和 <EventEmitter> 对象的默认最大值。

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.addAbortListener(signal, listener)#

• signal <AbortSignal>
• listener <Function> | <EventListener>
• 返回： <Disposable> 删除 abort 监听器。

在提供的 signal 上监听一次 abort 事件。

监听中止信号上的 abort 事件是不安全的，并且可能导致资源泄漏，因为具有该信号的另一个第三方可以调用 e.stopImmediatePropagation()。 不幸的是 Node.js 无法改变这一点，因为它违反了 Web 标准。 此外，原始 API 很容易忘记删除监听器。

此 API 允许在 Node.js API 中安全地使用 AbortSignal，通过监听事件来解决这两个问题，这样 stopImmediatePropagation 就不会阻止监听器运行。

返回一次性内容，以便更轻松地取消订阅。

const { addAbortListener } = require('node:events');

function example(signal) {
  let disposable;
  try {
    signal.addEventListener('abort', (e) => e.stopImmediatePropagation());
    disposable = addAbortListener(signal, (e) => {
      // Do something when signal is aborted.
    });
  } finally {
    disposable?.[Symbol.dispose]();
  }
}import { addAbortListener } from 'node:events';

function example(signal) {
  let disposable;
  try {
    signal.addEventListener('abort', (e) => e.stopImmediatePropagation());
    disposable = addAbortListener(signal, (e) => {
      // Do something when signal is aborted.
    });
  } finally {
    disposable?.[Symbol.dispose]();
  }
}拷贝

类：events.EventEmitterAsyncResource extends EventEmitter#

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

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

// Async tracking tooling will identify this as 'Q'.
const ee1 = new EventEmitterAsyncResource({ name: 'Q' });

// 'foo' listeners will run in the EventEmitters async context.
ee1.on('foo', () => {
  strictEqual(executionAsyncId(), ee1.asyncId);
  strictEqual(triggerAsyncId(), ee1.triggerAsyncId);
});

const ee2 = new EventEmitter();

// 'foo' listeners on ordinary EventEmitters that do not track async
// context, however, run in the same async context as the emit().
ee2.on('foo', () => {
  notStrictEqual(executionAsyncId(), ee2.asyncId);
  notStrictEqual(triggerAsyncId(), ee2.triggerAsyncId);
});

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

// Async tracking tooling will identify this as 'Q'.
const ee1 = new EventEmitterAsyncResource({ name: 'Q' });

// 'foo' listeners will run in the EventEmitters async context.
ee1.on('foo', () => {
  strictEqual(executionAsyncId(), ee1.asyncId);
  strictEqual(triggerAsyncId(), ee1.triggerAsyncId);
});

const ee2 = new EventEmitter();

// 'foo' listeners on ordinary EventEmitters that do not track async
// context, however, run in the same async context as the 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>。

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

eventemitterasyncresource.emitDestroy()#

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

eventemitterasyncresource.triggerAsyncId#

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

EventTarget 和 Event API#

EventTarget 和 Event 对象是 EventTarget 网络 API 的特定于 Node.js 的实现，由一些 Node.js 核心 API 公开。

const target = new EventTarget();

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

Node.js EventTarget 与 DOM EventTarget#

Node.js EventTarget 和 EventTarget 网络 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() 和 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);  // Prints 'foo'
  event.a = 1;
}

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

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

const handler4 = {
  async handleEvent(event) {
    console.log(event.type);  // Prints '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#

Event 对象是 Event 网络 API 的改编版。 实例由 Node.js 在内部创建。

event.bubbles#

• 类型： <boolean> 总是返回 false。

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

event.cancelBubble#

• 类型： <boolean>

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

event.cancelable#

• 类型： <boolean> 如果事件是使用 cancelable 选项创建的，则为真。

event.composed#

• 类型： <boolean> 总是返回 false。

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

event.composedPath()#

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

event.currentTarget#

• 类型： <EventTarget> 调度事件的 EventTarget。

event.target 的别名。

event.defaultPrevented#

• 类型： <boolean>

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

event.eventPhase#

• 类型： <number> 事件未被调度时返回 0，事件被调度时返回 2。

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

event.initEvent(type[, bubbles[, cancelable]])#

• type <string>
• bubbles <boolean>
• cancelable <boolean>

事件构造函数冗余且无法设置 composed。 这在 Node.js 中没有使用，纯粹是为了完整性而提供的。

event.isTrusted#

• 类型： <boolean>

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

event.preventDefault()#

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

event.returnValue#

• 类型： <boolean> 如果事件尚未取消，则为真。

event.returnValue 的值总是与 event.defaultPrevented 相反。 这在 Node.js 中没有使用，纯粹是为了完整性而提供的。

event.srcElement#

• 类型： <EventTarget> 调度事件的 EventTarget。

event.target 的别名。

event.stopImmediatePropagation()#

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

event.stopPropagation()#

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

event.target#

• 类型： <EventTarget> 调度事件的 EventTarget。

event.timeStamp#

• 类型： <number>

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

event.type#

• 类型： <string>

事件类型标识符。

类：EventTarget#

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

• 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 });  // first
target.addEventListener('foo', handler, { capture: false }); // second

// Removes the second instance of handler
target.removeEventListener('foo', handler);

// Removes the first instance of handler
target.removeEventListener('foo', handler, { capture: true }); 拷贝

eventTarget.dispatchEvent(event)#

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

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

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

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

• type <string>
• listener <Function> | <EventListener>
• options <Object>
  • capture <boolean>

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

类：CustomEvent#

• 继承： <Event>

CustomEvent 对象是 CustomEvent 网络 API 的改编版。 实例由 Node.js 在内部创建。

event.detail#

• 类型： <any> 返回初始化时传入的自定义数据。

只读。

类：NodeEventTarget#

• 继承： <EventTarget>

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

nodeEventTarget.addListener(type, listener)#

• type <string>

• listener <Function> | <EventListener>

• 返回： <EventTarget> 自身

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

nodeEventTarget.emit(type, arg)#

• type <string>
• arg <any>
• 返回： <boolean> 如果存在为 type 注册的事件监听器，则为 true，否则为 false。

EventTarget 类的 Node.js 特定扩展，将 arg 分派到 type 的处理程序列表。

nodeEventTarget.eventNames()#

• 返回： <string[]>

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

nodeEventTarget.listenerCount(type)#

• type <string>

• 返回： <number>

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

nodeEventTarget.setMaxListeners(n)#

• n <number>

EventTarget 类的 Node.js 特定扩展，将最大事件监听器的数量设置为 n。

nodeEventTarget.getMaxListeners()#

• 返回： <number>

返回最大事件监听器数量的 EventTarget 类的 Node.js 特定扩展。

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

• type <string>

• listener <Function> | <EventListener>

• options <Object>

  • capture <boolean>

• 返回： <EventTarget> 自身

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

nodeEventTarget.on(type, listener)#

• type <string>

• listener <Function> | <EventListener>

• 返回： <EventTarget> 自身

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

nodeEventTarget.once(type, listener)#

• type <string>

• listener <Function> | <EventListener>

• 返回： <EventTarget> 自身

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

nodeEventTarget.removeAllListeners([type])#

• type <string>

• 返回： <EventTarget> 自身

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

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

• type <string>

• listener <Function> | <EventListener>

• options <Object>

  • capture <boolean>

• 返回： <EventTarget> 自身

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