Twin class

  • Referência
Pacote:
azure-iot-device

Um Dispositivo Duplo é um documento que descreve o estado de um dispositivo armazenado por um hub IoT do Azure e que está disponível mesmo que o dispositivo esteja offline. É criado em torno de 3 secções:

  • Etiquetas: pares chave/valor apenas acessíveis a partir do lado do serviço
  • Propriedades Pretendidas: atualizadas por um serviço e recebidas pelo dispositivo
  • Propriedades Reportadas: atualizadas pelo dispositivo e recebidas pelo serviço.

Tenha em atenção que, embora seja uma possibilidade, as propriedades pretendidas e comunicadas não têm de corresponder e que a lógica para sincronizar estas duas coleções, se necessário, é deixada ao utilizador do SDK.

Para obter mais informações, veja Understanding Device Twins (Compreender os Dispositivos Duplos).

Extends

EventEmitter

Propriedades

desiredPath
errorEvent
properties

Os dicionários de propriedades pretendidos e comunicados (respetivamente em properties.desired e properties.reported).
userRegisteredDesiredPropertiesListener

Propriedades Herdadas

captureRejections

Valor: booleano

Altere a opção predefinida captureRejections em todos os novos EventEmitter objetos.
captureRejectionSymbol

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

Veja como escrever um personalizado rejection handler.
defaultMaxListeners

Por predefinição, pode ser registado um máximo de serviços de 10 escuta para qualquer evento individual. Este limite pode ser alterado para instâncias individuais EventEmitter com o emitter.setMaxListeners(n) método . Para alterar a predefinição para todas asEventEmitter instâncias, a events.defaultMaxListeners propriedade pode ser utilizada. Se este valor não for um número positivo, é lançado um RangeError .

Tenha cuidado ao definir o events.defaultMaxListeners porque a alteração afeta todas as instâncias, incluindo as EventEmitter criadas antes de a alteração ser efetuada. No entanto, a chamada emitter.setMaxListeners(n) ainda tem precedência sobre events.defaultMaxListeners.

Este não é um limite difícil. A EventEmitter instância permitirá a adição de mais serviços de escuta, mas irá enviar um aviso de rastreio para o stderr, indicando que foi detetada uma "possível fuga de memória eventEmitter". Para qualquer , EventEmitteros emitter.getMaxListeners() métodos e emitter.setMaxListeners() podem ser utilizados para evitar temporariamente este aviso:

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

O --trace-warnings sinalizador da linha de comandos pode ser utilizado para apresentar o rastreio de pilha para tais avisos.

O aviso emitido pode ser inspecionado com process.on('warning') e terá as propriedades adicionais emitter, typee count , referentes à instância do emissor de eventos, ao nome do evento e ao número de serviços de escuta anexados, respetivamente. A name propriedade está definida como 'MaxListenersExceededWarning'.
errorMonitor

Este símbolo deve ser utilizado para instalar um serviço de escuta apenas para eventos de monitorização 'error' . Os serviços de escuta instalados com este símbolo são chamados antes de os serviços de escuta regulares 'error' serem chamados.

Instalar um serviço de escuta com este símbolo não altera o comportamento depois de um 'error' evento ser emitido. Por conseguinte, o processo continuará a falhar se não estiver instalado nenhum serviço de escuta normal 'error' .

Métodos

get()
get(Callback<Twin>)

Obtém o duplo completo do serviço.

Métodos Herdados

addAbortListener(AbortSignal, (event: Event) => void)

Escuta uma vez o abort evento no fornecido signal.

Ouvir o abort evento em sinais de abortar não é seguro e pode levar a fugas de recursos, uma vez que outros terceiros com o sinal podem chamar e.stopImmediatePropagation(). Infelizmente, Node.js não pode alterar esta situação, uma vez que violaria a norma Web. Além disso, a API original facilita a remoção de serviços de escuta.

Esta API permite a utilização AbortSignalsegura de s nas APIs Node.js ao resolver estes dois problemas ao escutar o evento de forma a stopImmediatePropagation não impedir a execução do serviço de escuta.

Devolve um descartável para que possa ser anulada a subscrição de mais facilmente.

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]();
  }
}
addListener<K>(string | symbol, (args: any[]) => void)

Alias para emitter.on(eventName, listener).
emit<K>(string | symbol, AnyRest)

Chama de forma síncrona cada um dos serviços de escuta registados para o evento com o nome eventName, pela ordem em que foram registados, transmitindo os argumentos fornecidos para cada um.

Devolve true se o evento tiver serviços de escuta, false caso contrário.

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

// First listener
myEmitter.on('event', function firstListener() {
  console.log('Helloooo! first listener');
});
// Second listener
myEmitter.on('event', function secondListener(arg1, arg2) {
  console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
});
// Third listener
myEmitter.on('event', function thirdListener(...args) {
  const parameters = args.join(', ');
  console.log(`event with parameters ${parameters} in third listener`);
});

console.log(myEmitter.listeners('event'));

myEmitter.emit('event', 1, 2, 3, 4, 5);

// Prints:
// [
//   [Function: firstListener],
//   [Function: secondListener],
//   [Function: thirdListener]
// ]
// Helloooo! first listener
// event with parameters 1, 2 in second listener
// event with parameters 1, 2, 3, 4, 5 in third listener
eventNames()

Devolve uma matriz que lista os eventos para os quais o emissor registou serviços de escuta. Os valores na matriz são cadeias ou Symbols.

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) ]
getEventListeners(EventEmitter<DefaultEventMap> | _DOMEventTarget, string | symbol)

Devolve uma cópia da matriz de serviços de escuta do evento com o nome eventName.

Para EventEmitters, este comportamento tem exatamente o mesmo comportamento que chamar .listeners o emissor.

Para EventTargets, esta é a única forma de obter os serviços de escuta de eventos para o destino do evento. Isto é útil para fins de depuração e diagnóstico.

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] ]
}
getMaxListeners()

Devolve o valor máximo do serviço de escuta atual para o EventEmitter que está definido por emitter.setMaxListeners(n) ou predefinição para defaultMaxListeners.
getMaxListeners(EventEmitter<DefaultEventMap> | _DOMEventTarget)

Devolve a quantidade máxima de serviços de escuta atualmente definida.

Para EventEmitters, este comportamento tem exatamente o mesmo comportamento que chamar .getMaxListeners o emissor.

Para EventTargets, esta é a única forma de obter o número máximo de serviços de escuta de eventos para o destino do evento. Se o número de processadores de eventos num único EventTarget exceder o conjunto máximo, o EventTarget irá imprimir um aviso.

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
}
listenerCount(EventEmitter<DefaultEventMap>, string | symbol)

Um método de classe que devolve o número de serviços de escuta do dado eventName registado no especificado emitter.

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

const myEmitter = new EventEmitter();
myEmitter.on('event', () => {});
myEmitter.on('event', () => {});
console.log(listenerCount(myEmitter, 'event'));
// Prints: 2
listenerCount<K>(string | symbol, Function)

Devolve o número de serviços de escuta que escutam o evento com o nome eventName. Se listener for fornecido, devolverá o número de vezes que o serviço de escuta é encontrado na lista de serviços de escuta do evento.
listeners<K>(string | symbol)

Devolve uma cópia da matriz de serviços de escuta do evento com o nome eventName.

server.on('connection', (stream) => {
  console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]
off<K>(string | symbol, (args: any[]) => void)

Alias para emitter.removeListener().
on(EventEmitter<DefaultEventMap>, string, StaticEventEmitterOptions) 
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 here

Devolve um AsyncIterator que itera eventos eventName . Será emitida se o EventEmitter emiter 'error'. Remove todos os serviços de escuta ao sair do ciclo. O value devolvido por cada iteração é uma matriz composta pelos argumentos de evento emitidos.

Um AbortSignal pode ser utilizado para cancelar a espera de eventos:

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());
on<K>(string | symbol, (args: any[]) => void)

Adiciona a listener função ao fim da matriz de serviços de escuta do evento com o nome eventName. Não são efetuadas verificações para ver se o listener já foi adicionado. Múltiplas chamadas que transmitem a mesma combinação de eventName e listener resultarão na adição listener e chamada de várias vezes.

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

Devolve uma referência ao , para que as EventEmitterchamadas possam ser encadeadas.

Por predefinição, os serviços de escuta de eventos são invocados pela ordem em que são adicionados. O emitter.prependListener() método pode ser utilizado como alternativa para adicionar o serviço de escuta de eventos ao início da matriz de serviços de escuta.

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
//   a
once(EventEmitter<DefaultEventMap>, string | symbol, StaticEventEmitterOptions)

Cria um Promise que é cumprido quando emite o EventEmitter evento especificado ou que é rejeitado se o EventEmitter emite 'error' enquanto aguarda. O Promise será resolvido com uma matriz de todos os argumentos emitidos para o evento especificado.

Este método é intencionalmente genérico e funciona com a interface EventTarget da plataforma Web, que não tem semântica de evento especial'error' e não ouve o 'error' evento.

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

O processamento especial do 'error' evento só é utilizado quando events.once() é utilizado para aguardar por outro evento. Se events.once() for utilizado para aguardar o evento emerror' si, será tratado como qualquer outro tipo de evento sem processamento especial:

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

Um AbortSignal pode ser utilizado para cancelar a espera do evento:

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!
once(_DOMEventTarget, string, StaticEventEmitterOptions)
once<K>(string | symbol, (args: any[]) => void)

Adiciona uma função únicalistener para o evento com o nome eventName. Da próxima vez eventName que for acionado, este serviço de escuta é removido e, em seguida, invocado.

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

Devolve uma referência ao , para que as EventEmitterchamadas possam ser encadeadas.

Por predefinição, os serviços de escuta de eventos são invocados pela ordem em que são adicionados. O emitter.prependOnceListener() método pode ser utilizado como alternativa para adicionar o serviço de escuta de eventos ao início da matriz de serviços de escuta.

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
//   a
prependListener<K>(string | symbol, (args: any[]) => void)

Adiciona a listener função ao início da matriz de serviços de escuta do evento com o nome eventName. Não são efetuadas verificações para ver se o listener já foi adicionado. Múltiplas chamadas que transmitem a mesma combinação de eventName e listener resultarão na adição listener e chamada de várias vezes.

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

Devolve uma referência ao , para que as EventEmitterchamadas possam ser encadeadas.
prependOnceListener<K>(string | symbol, (args: any[]) => void)

Adiciona uma função únicalistener para o evento com o nome eventName ao início da matriz de serviços de escuta. Da próxima vez eventName que for acionado, este serviço de escuta é removido e, em seguida, invocado.

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

Devolve uma referência ao , para que as EventEmitterchamadas possam ser encadeadas.
rawListeners<K>(string | symbol)

Devolve uma cópia da matriz de serviços de escuta do evento com o nome eventName, incluindo quaisquer wrappers (como os criados por .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');
removeAllListeners(string | symbol)

Remove todos os serviços de escuta ou os do especificado eventName.

É uma má prática remover os serviços de escuta adicionados noutro local no código, especialmente quando a EventEmitter instância foi criada por outro componente ou módulo (por exemplo, sockets ou fluxos de ficheiros).

Devolve uma referência ao , para que as EventEmitterchamadas possam ser encadeadas.
removeListener<K>(string | symbol, (args: any[]) => void)

Remove o especificado listener da matriz de serviço de escuta do evento com o nome eventName.

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

removeListener() irá remover, no máximo, uma instância de um serviço de escuta da matriz do serviço de escuta. Se um único serviço de escuta tiver sido adicionado várias vezes à matriz do serviço de escuta para a especificada eventName, removeListener() tem de ser chamado várias vezes para remover cada instância.

Assim que um evento é emitido, todos os serviços de escuta anexados ao mesmo no momento da emissão são chamados por ordem. Isto implica que qualquer removeListener() chamada ou removeAllListeners()depois de emitir e antes de o último serviço de escuta terminar a execução não irá removê-las deemit() em curso. Os eventos subsequentes comportam-se conforme esperado.

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:
//   A

Uma vez que os serviços de escuta são geridos através de uma matriz interna, chamar isto irá alterar os índices de posição de qualquer serviço de escuta registado após o serviço de escuta ser removido. Isto não afetará a ordem pela qual os serviços de escuta são chamados, mas significa que todas as cópias da matriz do serviço de escuta, conforme devolvido pelo emitter.listeners() método, terão de ser recriadas.

Quando uma única função tiver sido adicionada como processador várias vezes para um único evento (como no exemplo abaixo), removeListener() removerá a instância adicionada mais recentemente. No exemplo, o once('ping') serviço de escuta é removido:

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

Devolve uma referência ao , para que as EventEmitterchamadas possam ser encadeadas.
setMaxListeners(number)

Por predefinição EventEmitter, o s imprime um aviso se forem adicionados mais do que 10 serviços de escuta a um evento específico. Esta é uma predefinição útil que ajuda a encontrar fugas de memória. O emitter.setMaxListeners() método permite que o limite seja modificado para esta instância específica EventEmitter . O valor pode ser definido como Infinity (ou 0) para indicar um número ilimitado de serviços de escuta.

Devolve uma referência ao , para que as EventEmitterchamadas possam ser encadeadas.
setMaxListeners(number, (EventEmitter<DefaultEventMap> | _DOMEventTarget)[]) 
import { setMaxListeners, EventEmitter } from 'node:events';

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

setMaxListeners(5, target, emitter);
[captureRejectionSymbol]<K>(Error, string | symbol, AnyRest)

Detalhes de Propriedade

desiredPath 

static desiredPath: string

Valor de Propriedade

string

errorEvent 

static errorEvent: string

Valor de Propriedade

string

properties

Os dicionários de propriedades pretendidos e comunicados (respetivamente em properties.desired e properties.reported).

properties: TwinProperties

Valor de Propriedade

TwinProperties

userRegisteredDesiredPropertiesListener 

userRegisteredDesiredPropertiesListener: boolean

Valor de Propriedade

boolean

Detalhes da Propriedade Herdada

captureRejections

Valor: booleano

Altere a opção predefinida captureRejections em todos os novos EventEmitter objetos.

static captureRejections: boolean

Valor de Propriedade

boolean

Herdado de EventEmitter.captureRejections

captureRejectionSymbol

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

Veja como escrever um personalizado rejection handler.

static captureRejectionSymbol: typeof captureRejectionSymbol

Valor de Propriedade

typeof captureRejectionSymbol

Herdado de EventEmitter.captureRejectionSymbol

defaultMaxListeners

Por predefinição, pode ser registado um máximo de serviços de 10 escuta para qualquer evento individual. Este limite pode ser alterado para instâncias individuais EventEmitter com o emitter.setMaxListeners(n) método . Para alterar a predefinição para todas asEventEmitter instâncias, a events.defaultMaxListeners propriedade pode ser utilizada. Se este valor não for um número positivo, é lançado um RangeError .

Tenha cuidado ao definir o events.defaultMaxListeners porque a alteração afeta todas as instâncias, incluindo as EventEmitter criadas antes de a alteração ser efetuada. No entanto, a chamada emitter.setMaxListeners(n) ainda tem precedência sobre events.defaultMaxListeners.

Este não é um limite difícil. A EventEmitter instância permitirá a adição de mais serviços de escuta, mas irá enviar um aviso de rastreio para o stderr, indicando que foi detetada uma "possível fuga de memória eventEmitter". Para qualquer , EventEmitteros emitter.getMaxListeners() métodos e emitter.setMaxListeners() podem ser utilizados para evitar temporariamente este aviso:

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

O --trace-warnings sinalizador da linha de comandos pode ser utilizado para apresentar o rastreio de pilha para tais avisos.

O aviso emitido pode ser inspecionado com process.on('warning') e terá as propriedades adicionais emitter, typee count , referentes à instância do emissor de eventos, ao nome do evento e ao número de serviços de escuta anexados, respetivamente. A name propriedade está definida como 'MaxListenersExceededWarning'.

static defaultMaxListeners: number

Valor de Propriedade

number

Herdado de EventEmitter.defaultMaxListeners

errorMonitor

Este símbolo deve ser utilizado para instalar um serviço de escuta apenas para eventos de monitorização 'error' . Os serviços de escuta instalados com este símbolo são chamados antes de os serviços de escuta regulares 'error' serem chamados.

Instalar um serviço de escuta com este símbolo não altera o comportamento depois de um 'error' evento ser emitido. Por conseguinte, o processo continuará a falhar se não estiver instalado nenhum serviço de escuta normal 'error' .

static errorMonitor: typeof errorMonitor

Valor de Propriedade

typeof errorMonitor

Herdado de EventEmitter.errorMonitor

Detalhes de Método

get() 

function get(): Promise<Twin>

Devoluções

Promise<Twin>

get(Callback<Twin>)

Obtém o duplo completo do serviço.

function get(callback?: Callback<Twin>)

Parâmetros

callback

Callback<Twin>

função opcional que deve ser chamada de volta com o duplo ou um erro se o transporte não conseguir obter o duplo.

Detalhes do Método Herdado

addAbortListener(AbortSignal, (event: Event) => void)

Escuta uma vez o abort evento no fornecido signal.

Ouvir o abort evento em sinais de abortar não é seguro e pode levar a fugas de recursos, uma vez que outros terceiros com o sinal podem chamar e.stopImmediatePropagation(). Infelizmente, Node.js não pode alterar esta situação, uma vez que violaria a norma Web. Além disso, a API original facilita a remoção de serviços de escuta.

Esta API permite a utilização AbortSignalsegura de s nas APIs Node.js ao resolver estes dois problemas ao escutar o evento de forma a stopImmediatePropagation não impedir a execução do serviço de escuta.

Devolve um descartável para que possa ser anulada a subscrição de mais facilmente.

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]();
  }
}

static function addAbortListener(signal: AbortSignal, resource: (event: Event) => void): Disposable

Parâmetros

signal

AbortSignal

resource

(event: Event) => void

Devoluções

Disposable

Descartável que remove o abort serviço de escuta.

Herdado de EventEmitter.addAbortListener

addListener<K>(string | symbol, (args: any[]) => void)

Alias para emitter.on(eventName, listener).

function addListener<K>(eventName: string | symbol, listener: (args: any[]) => void): Twin

Parâmetros

eventName

string | symbol

listener

(args: any[]) => void

Devoluções

Twin

Herdado de EventEmitter.addListener

emit<K>(string | symbol, AnyRest)

Chama de forma síncrona cada um dos serviços de escuta registados para o evento com o nome eventName, pela ordem em que foram registados, transmitindo os argumentos fornecidos para cada um.

Devolve true se o evento tiver serviços de escuta, false caso contrário.

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

// First listener
myEmitter.on('event', function firstListener() {
  console.log('Helloooo! first listener');
});
// Second listener
myEmitter.on('event', function secondListener(arg1, arg2) {
  console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
});
// Third listener
myEmitter.on('event', function thirdListener(...args) {
  const parameters = args.join(', ');
  console.log(`event with parameters ${parameters} in third listener`);
});

console.log(myEmitter.listeners('event'));

myEmitter.emit('event', 1, 2, 3, 4, 5);

// Prints:
// [
//   [Function: firstListener],
//   [Function: secondListener],
//   [Function: thirdListener]
// ]
// Helloooo! first listener
// event with parameters 1, 2 in second listener
// event with parameters 1, 2, 3, 4, 5 in third listener

function emit<K>(eventName: string | symbol, args: AnyRest): boolean

Parâmetros

eventName

string | symbol

args

AnyRest

Devoluções

boolean

Herdado de EventEmitter.emit

eventNames()

Devolve uma matriz que lista os eventos para os quais o emissor registou serviços de escuta. Os valores na matriz são cadeias ou Symbols.

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) ]

function eventNames(): (string | symbol)[]

Devoluções

(string | symbol)[]

Herdado de EventEmitter.eventNames

getEventListeners(EventEmitter<DefaultEventMap> | _DOMEventTarget, string | symbol)

Devolve uma cópia da matriz de serviços de escuta do evento com o nome eventName.

Para EventEmitters, este comportamento tem exatamente o mesmo comportamento que chamar .listeners o emissor.

Para EventTargets, esta é a única forma de obter os serviços de escuta de eventos para o destino do evento. Isto é útil para fins de depuração e diagnóstico.

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] ]
}

static function getEventListeners(emitter: EventEmitter<DefaultEventMap> | _DOMEventTarget, name: string | symbol): Function[]

Parâmetros

emitter

EventEmitter<DefaultEventMap> | _DOMEventTarget

name

string | symbol

Devoluções

Function[]

Herdado de EventEmitter.getEventListeners

getMaxListeners()

Devolve o valor máximo do serviço de escuta atual para o EventEmitter que está definido por emitter.setMaxListeners(n) ou predefinição para defaultMaxListeners.

function getMaxListeners(): number

Devoluções

number

Herdado de EventEmitter.getMaxListeners

getMaxListeners(EventEmitter<DefaultEventMap> | _DOMEventTarget)

Devolve a quantidade máxima de serviços de escuta atualmente definida.

Para EventEmitters, este comportamento tem exatamente o mesmo comportamento que chamar .getMaxListeners o emissor.

Para EventTargets, esta é a única forma de obter o número máximo de serviços de escuta de eventos para o destino do evento. Se o número de processadores de eventos num único EventTarget exceder o conjunto máximo, o EventTarget irá imprimir um aviso.

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
}

static function getMaxListeners(emitter: EventEmitter<DefaultEventMap> | _DOMEventTarget): number

Parâmetros

emitter

EventEmitter<DefaultEventMap> | _DOMEventTarget

Devoluções

number

Herdado de EventEmitter.getMaxListeners

listenerCount(EventEmitter<DefaultEventMap>, string | symbol)

Aviso

Esta API foi preterida.

Since v3.2.0 - Use listenerCount instead.

Um método de classe que devolve o número de serviços de escuta do dado eventName registado no especificado emitter.

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

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

static function listenerCount(emitter: EventEmitter<DefaultEventMap>, eventName: string | symbol): number

Parâmetros

emitter

EventEmitter<DefaultEventMap>

O emissor a consultar

eventName

string | symbol

O nome do evento

Devoluções

number

Herdado de EventEmitter.listenerCount

listenerCount<K>(string | symbol, Function)

Devolve o número de serviços de escuta que escutam o evento com o nome eventName. Se listener for fornecido, devolverá o número de vezes que o serviço de escuta é encontrado na lista de serviços de escuta do evento.

function listenerCount<K>(eventName: string | symbol, listener?: Function): number

Parâmetros

eventName

string | symbol

O nome do evento que está a ser escutado

listener

Function

A função do processador de eventos

Devoluções

number

Herdado de EventEmitter.listenerCount

listeners<K>(string | symbol)

Devolve uma cópia da matriz de serviços de escuta do evento com o nome eventName.

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

function listeners<K>(eventName: string | symbol): Function[]

Parâmetros

eventName

string | symbol

Devoluções

Function[]

Herdado de EventEmitter.listeners

off<K>(string | symbol, (args: any[]) => void)

Alias para emitter.removeListener().

function off<K>(eventName: string | symbol, listener: (args: any[]) => void): Twin

Parâmetros

eventName

string | symbol

listener

(args: any[]) => void

Devoluções

Twin

Herdado de EventEmitter.off

on(EventEmitter<DefaultEventMap>, string, StaticEventEmitterOptions) 

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 here

Devolve um AsyncIterator que itera eventos eventName . Será emitida se o EventEmitter emiter 'error'. Remove todos os serviços de escuta ao sair do ciclo. O value devolvido por cada iteração é uma matriz composta pelos argumentos de evento emitidos.

Um AbortSignal pode ser utilizado para cancelar a espera de eventos:

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

static function on(emitter: EventEmitter<DefaultEventMap>, eventName: string, options?: StaticEventEmitterOptions): AsyncIterableIterator<any>

Parâmetros

emitter

EventEmitter<DefaultEventMap>

eventName

string

O nome do evento que está a ser escutado

options

StaticEventEmitterOptions

Devoluções

AsyncIterableIterator<any>

Um AsyncIterator que itera eventos emitidos eventName pelo emitter

Herdado de EventEmitter.on

on<K>(string | symbol, (args: any[]) => void)

Adiciona a listener função ao fim da matriz de serviços de escuta do evento com o nome eventName. Não são efetuadas verificações para ver se o listener já foi adicionado. Múltiplas chamadas que transmitem a mesma combinação de eventName e listener resultarão na adição listener e chamada de várias vezes.

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

Devolve uma referência ao , para que as EventEmitterchamadas possam ser encadeadas.

Por predefinição, os serviços de escuta de eventos são invocados pela ordem em que são adicionados. O emitter.prependListener() método pode ser utilizado como alternativa para adicionar o serviço de escuta de eventos ao início da matriz de serviços de escuta.

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
//   a

function on<K>(eventName: string | symbol, listener: (args: any[]) => void): Twin

Parâmetros

eventName

string | symbol

O nome do evento.

listener

(args: any[]) => void

A função de chamada de retorno

Devoluções

Twin

Herdado de EventEmitter.on

once(EventEmitter<DefaultEventMap>, string | symbol, StaticEventEmitterOptions)

Cria um Promise que é cumprido quando emite o EventEmitter evento especificado ou que é rejeitado se o EventEmitter emite 'error' enquanto aguarda. O Promise será resolvido com uma matriz de todos os argumentos emitidos para o evento especificado.

Este método é intencionalmente genérico e funciona com a interface EventTarget da plataforma Web, que não tem semântica de evento especial'error' e não ouve o 'error' evento.

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

O processamento especial do 'error' evento só é utilizado quando events.once() é utilizado para aguardar por outro evento. Se events.once() for utilizado para aguardar o evento emerror' si, será tratado como qualquer outro tipo de evento sem processamento especial:

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

Um AbortSignal pode ser utilizado para cancelar a espera do evento:

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!

static function once(emitter: EventEmitter<DefaultEventMap>, eventName: string | symbol, options?: StaticEventEmitterOptions): Promise<any[]>

Parâmetros

emitter

EventEmitter<DefaultEventMap>

eventName

string | symbol

options

StaticEventEmitterOptions

Devoluções

Promise<any[]>

Herdado de EventEmitter.once

once(_DOMEventTarget, string, StaticEventEmitterOptions) 

static function once(emitter: _DOMEventTarget, eventName: string, options?: StaticEventEmitterOptions): Promise<any[]>

Parâmetros

emitter

_DOMEventTarget

eventName

string

options

StaticEventEmitterOptions

Devoluções

Promise<any[]>

Herdado de EventEmitter.once

once<K>(string | symbol, (args: any[]) => void)

Adiciona uma função únicalistener para o evento com o nome eventName. Da próxima vez eventName que for acionado, este serviço de escuta é removido e, em seguida, invocado.

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

Devolve uma referência ao , para que as EventEmitterchamadas possam ser encadeadas.

Por predefinição, os serviços de escuta de eventos são invocados pela ordem em que são adicionados. O emitter.prependOnceListener() método pode ser utilizado como alternativa para adicionar o serviço de escuta de eventos ao início da matriz de serviços de escuta.

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
//   a

function once<K>(eventName: string | symbol, listener: (args: any[]) => void): Twin

Parâmetros

eventName

string | symbol

O nome do evento.

listener

(args: any[]) => void

A função de chamada de retorno

Devoluções

Twin

Herdado de EventEmitter.once

prependListener<K>(string | symbol, (args: any[]) => void)

Adiciona a listener função ao início da matriz de serviços de escuta do evento com o nome eventName. Não são efetuadas verificações para ver se o listener já foi adicionado. Múltiplas chamadas que transmitem a mesma combinação de eventName e listener resultarão na adição listener e chamada de várias vezes.

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

Devolve uma referência ao , para que as EventEmitterchamadas possam ser encadeadas.

function prependListener<K>(eventName: string | symbol, listener: (args: any[]) => void): Twin

Parâmetros

eventName

string | symbol

O nome do evento.

listener

(args: any[]) => void

A função de chamada de retorno

Devoluções

Twin

Herdado de EventEmitter.prependListener

prependOnceListener<K>(string | symbol, (args: any[]) => void)

Adiciona uma função únicalistener para o evento com o nome eventName ao início da matriz de serviços de escuta. Da próxima vez eventName que for acionado, este serviço de escuta é removido e, em seguida, invocado.

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

Devolve uma referência ao , para que as EventEmitterchamadas possam ser encadeadas.

function prependOnceListener<K>(eventName: string | symbol, listener: (args: any[]) => void): Twin

Parâmetros

eventName

string | symbol

O nome do evento.

listener

(args: any[]) => void

A função de chamada de retorno

Devoluções

Twin

Herdado de EventEmitter.prependOnceListener

rawListeners<K>(string | symbol)

Devolve uma cópia da matriz de serviços de escuta do evento com o nome eventName, incluindo quaisquer wrappers (como os criados por .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');

function rawListeners<K>(eventName: string | symbol): Function[]

Parâmetros

eventName

string | symbol

Devoluções

Function[]

Herdado de EventEmitter.rawListeners

removeAllListeners(string | symbol)

Remove todos os serviços de escuta ou os do especificado eventName.

É uma má prática remover os serviços de escuta adicionados noutro local no código, especialmente quando a EventEmitter instância foi criada por outro componente ou módulo (por exemplo, sockets ou fluxos de ficheiros).

Devolve uma referência ao , para que as EventEmitterchamadas possam ser encadeadas.

function removeAllListeners(eventName?: string | symbol): Twin

Parâmetros

eventName

string | symbol

Devoluções

Twin

Herdado de EventEmitter.removeAllListeners

removeListener<K>(string | symbol, (args: any[]) => void)

Remove o especificado listener da matriz de serviço de escuta do evento com o nome eventName.

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

removeListener() irá remover, no máximo, uma instância de um serviço de escuta da matriz do serviço de escuta. Se um único serviço de escuta tiver sido adicionado várias vezes à matriz do serviço de escuta para a especificada eventName, removeListener() tem de ser chamado várias vezes para remover cada instância.

Assim que um evento é emitido, todos os serviços de escuta anexados ao mesmo no momento da emissão são chamados por ordem. Isto implica que qualquer removeListener() chamada ou removeAllListeners()depois de emitir e antes de o último serviço de escuta terminar a execução não irá removê-las deemit() em curso. Os eventos subsequentes comportam-se conforme esperado.

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:
//   A

Uma vez que os serviços de escuta são geridos através de uma matriz interna, chamar isto irá alterar os índices de posição de qualquer serviço de escuta registado após o serviço de escuta ser removido. Isto não afetará a ordem pela qual os serviços de escuta são chamados, mas significa que todas as cópias da matriz do serviço de escuta, conforme devolvido pelo emitter.listeners() método, terão de ser recriadas.

Quando uma única função tiver sido adicionada como processador várias vezes para um único evento (como no exemplo abaixo), removeListener() removerá a instância adicionada mais recentemente. No exemplo, o once('ping') serviço de escuta é removido:

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

Devolve uma referência ao , para que as EventEmitterchamadas possam ser encadeadas.

function removeListener<K>(eventName: string | symbol, listener: (args: any[]) => void): Twin

Parâmetros

eventName

string | symbol

listener

(args: any[]) => void

Devoluções

Twin

Herdado de EventEmitter.removeListener

setMaxListeners(number)

Por predefinição EventEmitter, o s imprime um aviso se forem adicionados mais do que 10 serviços de escuta a um evento específico. Esta é uma predefinição útil que ajuda a encontrar fugas de memória. O emitter.setMaxListeners() método permite que o limite seja modificado para esta instância específica EventEmitter . O valor pode ser definido como Infinity (ou 0) para indicar um número ilimitado de serviços de escuta.

Devolve uma referência ao , para que as EventEmitterchamadas possam ser encadeadas.

function setMaxListeners(n: number): Twin

Parâmetros

n

number

Devoluções

Twin

Herdado de EventEmitter.setMaxListeners

setMaxListeners(number, (EventEmitter<DefaultEventMap> | _DOMEventTarget)[]) 

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

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

setMaxListeners(5, target, emitter);

static function setMaxListeners(n?: number, eventTargets: (EventEmitter<DefaultEventMap> | _DOMEventTarget)[])

Parâmetros

n

number

Um número não negativo. O número máximo de serviços de escuta por EventTarget evento.

eventTargets

(EventEmitter<DefaultEventMap> | _DOMEventTarget)[]

Herdado de EventEmitter.setMaxListeners

[captureRejectionSymbol]<K>(Error, string | symbol, AnyRest) 

function [captureRejectionSymbol]<K>(error: Error, event: string | symbol, args: AnyRest)

Parâmetros

error

Error

event

string | symbol

args

AnyRest

Herdado de EventEmitter.__@captureRejectionSymbol@138