Share via

Amqp class

  • Odwołanie
Pakiet:
azure-iothub

Klasa transportu używana przez klienta usługi do nawiązywania połączenia z usługą Azure IoT Hub przy użyciu protokołu AMQP za pośrednictwem bezpiecznego gniazda (TLS). Ta klasa nie powinna być używana bezpośrednio i zamiast tego przekazywana do jednej z Client metod fabrycznych: fromConnectionString lub fromSharedAccessSignature.

Extends

EventEmitter

Właściwości dziedziczone

captureRejections

Wartość: wartość logiczna

Zmień opcję domyślną captureRejections dla wszystkich nowych EventEmitter obiektów.
captureRejectionSymbol

Wartość: Symbol.for('nodejs.rejection')

Zobacz, jak napisać niestandardowy rejection handlerelement .
defaultMaxListeners

Domyślnie dla każdego pojedynczego 10 zdarzenia można zarejestrować maksymalnie odbiorniki. Ten limit można zmienić dla poszczególnych EventEmitter wystąpień przy użyciu emitter.setMaxListeners(n) metody . Aby zmienić wartość domyślną dla wszystkichEventEmitter wystąpień, events.defaultMaxListeners można użyć właściwości . Jeśli ta wartość nie jest liczbą dodatnią, RangeError jest zgłaszana wartość .

Należy zachować ostrożność podczas ustawiania events.defaultMaxListeners elementu , ponieważ zmiana wpływa na wszystkieEventEmitter wystąpienia, w tym te utworzone przed wprowadzeniem zmiany. Jednak wywołanie emitter.setMaxListeners(n) nadal ma pierwszeństwo przed .events.defaultMaxListeners

To nie jest twardy limit. Wystąpienie EventEmitter umożliwi dodanie większej liczby odbiorników, ale wyświetli ostrzeżenie śledzenia do stderr wskazujące, że wykryto "możliwy wyciek pamięci eventEmitter". W przypadku dowolnej pojedynczej EventEmittermetody emitter.getMaxListeners() i emitter.setMaxListeners() można użyć do tymczasowego uniknięcia tego ostrzeżenia:

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

Flaga --trace-warnings wiersza polecenia może służyć do wyświetlania śladu stosu dla takich ostrzeżeń.

Emitowane process.on('warning') ostrzeżenie można sprawdzić i będzie mieć dodatkowe emitterwłaściwości , typei count odwołujące się odpowiednio do wystąpienia emitera zdarzeń, nazwy zdarzenia i liczby dołączonych odbiorników. Jego name właściwość jest ustawiona na 'MaxListenersExceededWarning'wartość .
errorMonitor

Ten symbol służy do instalowania odbiornika tylko do monitorowania 'error' zdarzeń. Odbiorniki zainstalowane przy użyciu tego symbolu są wywoływane przed wywołaniami zwykłych 'error' odbiorników.

Instalowanie odbiornika przy użyciu tego symbolu nie zmienia zachowania po 'error' emisji zdarzenia. W związku z tym proces będzie nadal ulegał awarii, jeśli nie zainstalowano zwykłego 'error' odbiornika.

Metody dziedziczone

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

Nasłuchuje raz zdarzenia abort w podanym signalobiekcie .

abort Nasłuchiwanie zdarzenia za pomocą sygnałów przerwania jest niebezpieczne i może prowadzić do wycieków zasobów, ponieważ inna firma z sygnałem może wywołać metodę e.stopImmediatePropagation(). Niestety Node.js nie można tego zmienić, ponieważ naruszałoby to standard sieci Web. Ponadto oryginalny interfejs API ułatwia zapomnienie o usunięciu odbiorników.

Ten interfejs API umożliwia bezpieczne korzystanie z AbortSignalinterfejsów API w Node.js przez rozwiązanie tych dwóch problemów przez nasłuchiwanie zdarzenia, które stopImmediatePropagation nie zapobiega uruchomieniu odbiornika.

Zwraca jednorazowy element, dzięki czemu można go łatwiej anulować.

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 dla .emitter.on(eventName, listener)
emit<K>(string | symbol, AnyRest)

Synchronicznie wywołuje każdy odbiornik zarejestrowany dla zdarzenia o nazwie eventName, w kolejności, w której zostały zarejestrowane, przekazując podane argumenty do każdego z nich.

Zwraca true wartość , jeśli zdarzenie miało odbiorniki, false w przeciwnym razie.

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

Zwraca tablicę zawierającą listę zdarzeń, dla których emiter zarejestrował odbiorniki. Wartości w tablicy to ciągi lub 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> | EventTarget, string | symbol)

Zwraca kopię tablicy odbiorników dla zdarzenia o nazwie eventName.

W przypadku EventEmitterelementu działa to dokładnie tak samo jak wywołanie .listeners elementu emitującego.

Dla EventTargets jest to jedyny sposób, aby uzyskać odbiorniki zdarzeń dla obiektu docelowego zdarzenia. Jest to przydatne do debugowania i diagnostyki.

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

Zwraca bieżącą wartość maksymalnego odbiornika, EventEmitter która jest ustawiona domyślnie emitter.setMaxListeners(n) lub domyślnie ustawiona na wartość defaultMaxListeners.
getMaxListeners(EventEmitter<DefaultEventMap> | EventTarget)

Zwraca obecnie ustawioną maksymalną ilość odbiorników.

W przypadku EventEmitterelementu działa to dokładnie tak samo jak wywołanie .getMaxListeners elementu emitującego.

Dla EventTargets jest to jedyny sposób, aby uzyskać maksymalną liczbę odbiorników zdarzeń dla miejsca docelowego zdarzenia. Jeśli liczba procedur obsługi zdarzeń w pojedynczym obiekcie EventTarget przekracza maksymalny zestaw, usługa EventTarget wyświetli ostrzeżenie.

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)

Metoda klasy zwracająca liczbę odbiorników dla danej eventName zarejestrowanej na danym emitterobiekcie .

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)

Zwraca liczbę odbiorników nasłuchujących zdarzenia o nazwie eventName. Jeśli listener zostanie podana, zostanie zwrócona liczba wystąpień odbiornika na liście odbiorników zdarzenia.
listeners<K>(string | symbol)

Zwraca kopię tablicy odbiorników dla zdarzenia o nazwie 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 dla .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

Zwraca wartość, która AsyncIterator iteruje eventName zdarzenia. Spowoduje to zgłoszenie, jeśli emituje 'error'wartość EventEmitter . Usuwa wszystkie odbiorniki podczas zamykania pętli. Zwracana value przez każdą iterację jest tablicą składającą się z emitowanych argumentów zdarzeń.

Element AbortSignal może służyć do anulowania oczekiwania na zdarzenia:

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)

listener Dodaje funkcję na końcu tablicy odbiorników dla zdarzenia o nazwie eventName. Nie są sprawdzane, czy listener element został już dodany. Wiele wywołań przekazujących eventName tę samą kombinację elementów i listener spowoduje listener dodanie i wywołanie wielu razy.

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

Zwraca odwołanie do elementu EventEmitter, aby można było połączyć wywołania w łańcuch.

Domyślnie odbiorniki zdarzeń są wywoływane w kolejności, w której są dodawane. Metoda emitter.prependListener() może służyć jako alternatywa, aby dodać odbiornik zdarzeń na początku tablicy odbiorników.

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)

Promise Tworzy obiekt, który jest spełniony, gdy EventEmitter emituje dane zdarzenie lub jest odrzucany, jeśli EventEmitter emituje 'error' podczas oczekiwania. Funkcja Promise rozwiąże problem z tablicą wszystkich argumentów emitowanych do danego zdarzenia.

Ta metoda jest celowo ogólna i współpracuje z interfejsem platformy internetowej EventTarget , który nie ma specjalnej'error' semantyki zdarzeń i nie nasłuchuje 'error' zdarzenia.

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

Specjalna obsługa 'error' zdarzenia jest używana tylko wtedy, gdy events.once() jest używana do oczekiwania na inne zdarzenie. Jeśli events.once() jest używany do oczekiwania na samo zdarzenie ,error' jest traktowany jako dowolny inny rodzaj zdarzenia bez specjalnej obsługi:

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

Element AbortSignal może służyć do anulowania oczekiwania na zdarzenie:

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

Dodaje funkcję jednorazowąlistener dla zdarzenia o nazwie eventName. Następnym razem eventName zostanie wyzwolony odbiornik, a następnie wywołany.

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

Zwraca odwołanie do elementu EventEmitter, aby można było połączyć wywołania w łańcuch.

Domyślnie odbiorniki zdarzeń są wywoływane w kolejności, w której są dodawane. Metoda emitter.prependOnceListener() może służyć jako alternatywa, aby dodać odbiornik zdarzeń na początku tablicy odbiorników.

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)

listener Dodaje funkcję na początku tablicy odbiorników dla zdarzenia o nazwie eventName. Nie są sprawdzane, czy listener element został już dodany. Wiele wywołań przekazujących eventName tę samą kombinację elementów i listener spowoduje listener dodanie i wywołanie wielu razy.

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

Zwraca odwołanie do elementu EventEmitter, aby można było połączyć wywołania w łańcuch.
prependOnceListener<K>(string | symbol, (args: any[]) => void)

Dodaje jednorazowąlistener funkcję zdarzenia o nazwie eventName na początku tablicy odbiorników. Następnym razem eventName zostanie wyzwolony, ten odbiornik zostanie usunięty, a następnie wywołany.

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

Zwraca odwołanie do elementu EventEmitter, aby można było połączyć wywołania w łańcuch.
rawListeners<K>(string | symbol)

Zwraca kopię tablicy odbiorników dla zdarzenia o nazwie eventName, w tym wszelkie otoki (takie jak utworzone przez .once()program ).

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)

Usuwa wszystkie odbiorniki lub te z określonego eventNameelementu .

Niewłaściwą praktyką jest usunięcie odbiorników dodanych w innym miejscu w kodzie, szczególnie w przypadku EventEmitter utworzenia wystąpienia przez inny składnik lub moduł (np. gniazda lub strumienie plików).

Zwraca odwołanie do elementu EventEmitter, aby można było połączyć wywołania w łańcuch.
removeListener<K>(string | symbol, (args: any[]) => void)

Usuwa określony listener element z tablicy odbiorników dla zdarzenia o nazwie eventName.

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

removeListener() spowoduje usunięcie co najwyżej jednego wystąpienia odbiornika z tablicy odbiornika. Jeśli którykolwiek pojedynczy odbiornik został dodany wiele razy do tablicy odbiornika dla określonego eventNameelementu , removeListener() należy wywołać wiele razy, aby usunąć każde wystąpienie.

Po emitowaniu zdarzenia wszystkie odbiorniki dołączone do niego w momencie emitowania są wywoływane w kolejności. Oznacza to, że wszystkie removeListener() wywołania lub removeAllListeners()po emitowaniu i przed zakończeniem wykonywania ostatniego odbiornika nie zostaną usunięte zemit() postępu. Kolejne zdarzenia zachowują się zgodnie z oczekiwaniami.

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

Ponieważ odbiorniki są zarządzane przy użyciu tablicy wewnętrznej, wywołanie tej funkcji spowoduje zmianę indeksów pozycji każdego odbiornika zarejestrowanego po usunięciu odbiornika. Nie będzie to miało wpływu na kolejność wywoływanych odbiorników, ale oznacza to, że wszystkie kopie tablicy odbiorników zwrócone przez emitter.listeners() metodę będą musiały zostać ponownie odtworzone.

Jeśli pojedyncza funkcja została dodana jako procedura obsługi wiele razy dla pojedynczego zdarzenia (jak w poniższym przykładzie), removeListener() spowoduje usunięcie ostatnio dodanego wystąpienia. W przykładzie odbiornik once('ping') jest usuwany:

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

Zwraca odwołanie do elementu EventEmitter, aby można było połączyć wywołania w łańcuch.
setMaxListeners(number)

Domyślnie EventEmitterprogram wyświetli ostrzeżenie, jeśli dla określonego zdarzenia zostanie dodanych więcej niż 10 odbiorniki. Jest to przydatne ustawienie domyślne, które pomaga znaleźć przecieki pamięci. Metoda emitter.setMaxListeners() umożliwia zmodyfikowanie limitu dla tego konkretnego EventEmitter wystąpienia. Wartość można ustawić na Infinity (lub 0), aby wskazać nieograniczoną liczbę odbiorników.

Zwraca odwołanie do elementu EventEmitter, aby można było połączyć wywołania w łańcuch.
setMaxListeners(number, (EventEmitter<DefaultEventMap> | EventTarget)[]) 
import { setMaxListeners, EventEmitter } from 'node:events';

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

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

Szczegóły właściwości dziedziczonej

captureRejections

Wartość: wartość logiczna

Zmień opcję domyślną captureRejections dla wszystkich nowych EventEmitter obiektów.

static captureRejections: boolean

Wartość właściwości

boolean

Dziedziczone z EventEmitter.captureRejections

captureRejectionSymbol

Wartość: Symbol.for('nodejs.rejection')

Zobacz, jak napisać niestandardowy rejection handlerelement .

static captureRejectionSymbol: typeof captureRejectionSymbol

Wartość właściwości

typeof captureRejectionSymbol

Dziedziczone z EventEmitter.captureRejectionSymbol

defaultMaxListeners

Domyślnie dla każdego pojedynczego 10 zdarzenia można zarejestrować maksymalnie odbiorniki. Ten limit można zmienić dla poszczególnych EventEmitter wystąpień przy użyciu emitter.setMaxListeners(n) metody . Aby zmienić wartość domyślną dla wszystkichEventEmitter wystąpień, events.defaultMaxListeners można użyć właściwości . Jeśli ta wartość nie jest liczbą dodatnią, RangeError jest zgłaszana wartość .

Należy zachować ostrożność podczas ustawiania events.defaultMaxListeners elementu , ponieważ zmiana wpływa na wszystkieEventEmitter wystąpienia, w tym te utworzone przed wprowadzeniem zmiany. Jednak wywołanie emitter.setMaxListeners(n) nadal ma pierwszeństwo przed .events.defaultMaxListeners

To nie jest twardy limit. Wystąpienie EventEmitter umożliwi dodanie większej liczby odbiorników, ale wyświetli ostrzeżenie śledzenia do stderr wskazujące, że wykryto "możliwy wyciek pamięci eventEmitter". W przypadku dowolnej pojedynczej EventEmittermetody emitter.getMaxListeners() i emitter.setMaxListeners() można użyć do tymczasowego uniknięcia tego ostrzeżenia:

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

Flaga --trace-warnings wiersza polecenia może służyć do wyświetlania śladu stosu dla takich ostrzeżeń.

Emitowane process.on('warning') ostrzeżenie można sprawdzić i będzie mieć dodatkowe emitterwłaściwości , typei count odwołujące się odpowiednio do wystąpienia emitera zdarzeń, nazwy zdarzenia i liczby dołączonych odbiorników. Jego name właściwość jest ustawiona na 'MaxListenersExceededWarning'wartość .

static defaultMaxListeners: number

Wartość właściwości

number

Dziedziczone z EventEmitter.defaultMaxListeners

errorMonitor

Ten symbol służy do instalowania odbiornika tylko do monitorowania 'error' zdarzeń. Odbiorniki zainstalowane przy użyciu tego symbolu są wywoływane przed wywołaniami zwykłych 'error' odbiorników.

Instalowanie odbiornika przy użyciu tego symbolu nie zmienia zachowania po 'error' emisji zdarzenia. W związku z tym proces będzie nadal ulegał awarii, jeśli nie zainstalowano zwykłego 'error' odbiornika.

static errorMonitor: typeof errorMonitor

Wartość właściwości

typeof errorMonitor

Dziedziczone z EventEmitter.errorMonitor

Szczegóły metody dziedziczonej

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

Nasłuchuje raz zdarzenia abort w podanym signalobiekcie .

abort Nasłuchiwanie zdarzenia za pomocą sygnałów przerwania jest niebezpieczne i może prowadzić do wycieków zasobów, ponieważ inna firma z sygnałem może wywołać metodę e.stopImmediatePropagation(). Niestety Node.js nie można tego zmienić, ponieważ naruszałoby to standard sieci Web. Ponadto oryginalny interfejs API ułatwia zapomnienie o usunięciu odbiorników.

Ten interfejs API umożliwia bezpieczne korzystanie z AbortSignalinterfejsów API w Node.js przez rozwiązanie tych dwóch problemów przez nasłuchiwanie zdarzenia, które stopImmediatePropagation nie zapobiega uruchomieniu odbiornika.

Zwraca jednorazowy element, dzięki czemu można go łatwiej anulować.

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

Parametry

signal

AbortSignal

resource

(event: Event) => void

Zwraca

Disposable

Jednorazowy abort , który usuwa odbiornik.

Dziedziczone z EventEmitter.addAbortListener

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

Alias dla .emitter.on(eventName, listener)

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

Parametry

eventName

string | symbol

listener

(args: any[]) => void

Zwraca

Amqp

Dziedziczone z EventEmitter.addListener

emit<K>(string | symbol, AnyRest)

Synchronicznie wywołuje każdy odbiornik zarejestrowany dla zdarzenia o nazwie eventName, w kolejności, w której zostały zarejestrowane, przekazując podane argumenty do każdego z nich.

Zwraca true wartość , jeśli zdarzenie miało odbiorniki, false w przeciwnym razie.

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

Parametry

eventName

string | symbol

args

AnyRest

Zwraca

boolean

Dziedziczone z EventEmitter.emit

eventNames()

Zwraca tablicę zawierającą listę zdarzeń, dla których emiter zarejestrował odbiorniki. Wartości w tablicy to ciągi lub 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)[]

Zwraca

(string | symbol)[]

Dziedziczone z EventEmitter.eventNames

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

Zwraca kopię tablicy odbiorników dla zdarzenia o nazwie eventName.

W przypadku EventEmitterelementu działa to dokładnie tak samo jak wywołanie .listeners elementu emitującego.

Dla EventTargets jest to jedyny sposób, aby uzyskać odbiorniki zdarzeń dla obiektu docelowego zdarzenia. Jest to przydatne do debugowania i diagnostyki.

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> | EventTarget, name: string | symbol): Function[]

Parametry

emitter

EventEmitter<DefaultEventMap> | EventTarget

name

string | symbol

Zwraca

Function[]

Dziedziczone z EventEmitter.getEventListeners

getMaxListeners()

Zwraca bieżącą wartość maksymalnego odbiornika, EventEmitter która jest ustawiona domyślnie emitter.setMaxListeners(n) lub domyślnie ustawiona na wartość defaultMaxListeners.

function getMaxListeners(): number

Zwraca

number

Dziedziczone z EventEmitter.getMaxListeners

getMaxListeners(EventEmitter<DefaultEventMap> | EventTarget)

Zwraca obecnie ustawioną maksymalną ilość odbiorników.

W przypadku EventEmitterelementu działa to dokładnie tak samo jak wywołanie .getMaxListeners elementu emitującego.

Dla EventTargets jest to jedyny sposób, aby uzyskać maksymalną liczbę odbiorników zdarzeń dla miejsca docelowego zdarzenia. Jeśli liczba procedur obsługi zdarzeń w pojedynczym obiekcie EventTarget przekracza maksymalny zestaw, usługa EventTarget wyświetli ostrzeżenie.

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> | EventTarget): number

Parametry

emitter

EventEmitter<DefaultEventMap> | EventTarget

Zwraca

number

Dziedziczone z EventEmitter.getMaxListeners

listenerCount(EventEmitter<DefaultEventMap>, string | symbol)

Ostrzeżenie

Ten interfejs API jest już przestarzały.

Since v3.2.0 - Use listenerCount instead.

Metoda klasy zwracająca liczbę odbiorników dla danej eventName zarejestrowanej na danym emitterobiekcie .

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

Parametry

emitter

EventEmitter<DefaultEventMap>

Emiter do wykonywania zapytania

eventName

string | symbol

Nazwa zdarzenia

Zwraca

number

Dziedziczone z EventEmitter.listenerCount

listenerCount<K>(string | symbol, Function)

Zwraca liczbę odbiorników nasłuchujących zdarzenia o nazwie eventName. Jeśli listener zostanie podana, zostanie zwrócona liczba wystąpień odbiornika na liście odbiorników zdarzenia.

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

Parametry

eventName

string | symbol

Nazwa zdarzenia, dla których jest nasłuchiwane

listener

Function

Funkcja obsługi zdarzeń

Zwraca

number

Dziedziczone z EventEmitter.listenerCount

listeners<K>(string | symbol)

Zwraca kopię tablicy odbiorników dla zdarzenia o nazwie 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[]

Parametry

eventName

string | symbol

Zwraca

Function[]

Dziedziczone z EventEmitter.listeners

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

Alias dla .emitter.removeListener()

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

Parametry

eventName

string | symbol

listener

(args: any[]) => void

Zwraca

Amqp

Dziedziczone z 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

Zwraca wartość, która AsyncIterator iteruje eventName zdarzenia. Spowoduje to zgłoszenie, jeśli emituje 'error'wartość EventEmitter . Usuwa wszystkie odbiorniki podczas zamykania pętli. Zwracana value przez każdą iterację jest tablicą składającą się z emitowanych argumentów zdarzeń.

Element AbortSignal może służyć do anulowania oczekiwania na zdarzenia:

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>

Parametry

emitter

EventEmitter<DefaultEventMap>

eventName

string

Nazwa zdarzenia, dla których jest nasłuchiwane

options

StaticEventEmitterOptions

Zwraca

AsyncIterableIterator<any>

Element AsyncIterator , który iteruje eventName zdarzenia emitowane przez emitter

Dziedziczone z EventEmitter.on

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

listener Dodaje funkcję na końcu tablicy odbiorników dla zdarzenia o nazwie eventName. Nie są sprawdzane, czy listener element został już dodany. Wiele wywołań przekazujących eventName tę samą kombinację elementów i listener spowoduje listener dodanie i wywołanie wielu razy.

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

Zwraca odwołanie do elementu EventEmitter, aby można było połączyć wywołania w łańcuch.

Domyślnie odbiorniki zdarzeń są wywoływane w kolejności, w której są dodawane. Metoda emitter.prependListener() może służyć jako alternatywa, aby dodać odbiornik zdarzeń na początku tablicy odbiorników.

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): Amqp

Parametry

eventName

string | symbol

Nazwa zdarzenia.

listener

(args: any[]) => void

Funkcja wywołania zwrotnego

Zwraca

Amqp

Dziedziczone z EventEmitter.on

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

Promise Tworzy obiekt, który jest spełniony, gdy EventEmitter emituje dane zdarzenie lub jest odrzucany, jeśli EventEmitter emituje 'error' podczas oczekiwania. Funkcja Promise rozwiąże problem z tablicą wszystkich argumentów emitowanych do danego zdarzenia.

Ta metoda jest celowo ogólna i współpracuje z interfejsem platformy internetowej EventTarget , który nie ma specjalnej'error' semantyki zdarzeń i nie nasłuchuje 'error' zdarzenia.

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

Specjalna obsługa 'error' zdarzenia jest używana tylko wtedy, gdy events.once() jest używana do oczekiwania na inne zdarzenie. Jeśli events.once() jest używany do oczekiwania na samo zdarzenie ,error' jest traktowany jako dowolny inny rodzaj zdarzenia bez specjalnej obsługi:

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

Element AbortSignal może służyć do anulowania oczekiwania na zdarzenie:

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

Parametry

emitter

EventEmitter<DefaultEventMap>

eventName

string | symbol

options

StaticEventEmitterOptions

Zwraca

Promise<any[]>

Dziedziczone z EventEmitter.once

once(EventTarget, string, StaticEventEmitterOptions) 

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

Parametry

emitter

EventTarget

eventName

string

options

StaticEventEmitterOptions

Zwraca

Promise<any[]>

Dziedziczone z EventEmitter.once

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

Dodaje funkcję jednorazowąlistener dla zdarzenia o nazwie eventName. Następnym razem eventName zostanie wyzwolony odbiornik, a następnie wywołany.

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

Zwraca odwołanie do elementu EventEmitter, aby można było połączyć wywołania w łańcuch.

Domyślnie odbiorniki zdarzeń są wywoływane w kolejności, w której są dodawane. Metoda emitter.prependOnceListener() może służyć jako alternatywa, aby dodać odbiornik zdarzeń na początku tablicy odbiorników.

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): Amqp

Parametry

eventName

string | symbol

Nazwa zdarzenia.

listener

(args: any[]) => void

Funkcja wywołania zwrotnego

Zwraca

Amqp

Dziedziczone z EventEmitter.once

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

listener Dodaje funkcję na początku tablicy odbiorników dla zdarzenia o nazwie eventName. Nie są sprawdzane, czy listener element został już dodany. Wiele wywołań przekazujących eventName tę samą kombinację elementów i listener spowoduje listener dodanie i wywołanie wielu razy.

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

Zwraca odwołanie do elementu EventEmitter, aby można było połączyć wywołania w łańcuch.

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

Parametry

eventName

string | symbol

Nazwa zdarzenia.

listener

(args: any[]) => void

Funkcja wywołania zwrotnego

Zwraca

Amqp

Dziedziczone z EventEmitter.prependListener

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

Dodaje jednorazowąlistener funkcję zdarzenia o nazwie eventName na początku tablicy odbiorników. Następnym razem eventName zostanie wyzwolony, ten odbiornik zostanie usunięty, a następnie wywołany.

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

Zwraca odwołanie do elementu EventEmitter, aby można było połączyć wywołania w łańcuch.

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

Parametry

eventName

string | symbol

Nazwa zdarzenia.

listener

(args: any[]) => void

Funkcja wywołania zwrotnego

Zwraca

Amqp

Dziedziczone z EventEmitter.prependOnceListener

rawListeners<K>(string | symbol)

Zwraca kopię tablicy odbiorników dla zdarzenia o nazwie eventName, w tym wszelkie otoki (takie jak utworzone przez .once()program ).

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

Parametry

eventName

string | symbol

Zwraca

Function[]

Dziedziczone z EventEmitter.rawListeners

removeAllListeners(string | symbol)

Usuwa wszystkie odbiorniki lub te z określonego eventNameelementu .

Niewłaściwą praktyką jest usunięcie odbiorników dodanych w innym miejscu w kodzie, szczególnie w przypadku EventEmitter utworzenia wystąpienia przez inny składnik lub moduł (np. gniazda lub strumienie plików).

Zwraca odwołanie do elementu EventEmitter, aby można było połączyć wywołania w łańcuch.

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

Parametry

eventName

string | symbol

Zwraca

Amqp

Dziedziczone z EventEmitter.removeAllListeners

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

Usuwa określony listener element z tablicy odbiorników dla zdarzenia o nazwie eventName.

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

removeListener() spowoduje usunięcie co najwyżej jednego wystąpienia odbiornika z tablicy odbiornika. Jeśli którykolwiek pojedynczy odbiornik został dodany wiele razy do tablicy odbiornika dla określonego eventNameelementu , removeListener() należy wywołać wiele razy, aby usunąć każde wystąpienie.

Po emitowaniu zdarzenia wszystkie odbiorniki dołączone do niego w momencie emitowania są wywoływane w kolejności. Oznacza to, że wszystkie removeListener() wywołania lub removeAllListeners()po emitowaniu i przed zakończeniem wykonywania ostatniego odbiornika nie zostaną usunięte zemit() postępu. Kolejne zdarzenia zachowują się zgodnie z oczekiwaniami.

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

Ponieważ odbiorniki są zarządzane przy użyciu tablicy wewnętrznej, wywołanie tej funkcji spowoduje zmianę indeksów pozycji każdego odbiornika zarejestrowanego po usunięciu odbiornika. Nie będzie to miało wpływu na kolejność wywoływanych odbiorników, ale oznacza to, że wszystkie kopie tablicy odbiorników zwrócone przez emitter.listeners() metodę będą musiały zostać ponownie odtworzone.

Jeśli pojedyncza funkcja została dodana jako procedura obsługi wiele razy dla pojedynczego zdarzenia (jak w poniższym przykładzie), removeListener() spowoduje usunięcie ostatnio dodanego wystąpienia. W przykładzie odbiornik once('ping') jest usuwany:

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

Zwraca odwołanie do elementu EventEmitter, aby można było połączyć wywołania w łańcuch.

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

Parametry

eventName

string | symbol

listener

(args: any[]) => void

Zwraca

Amqp

Dziedziczone z EventEmitter.removeListener

setMaxListeners(number)

Domyślnie EventEmitterprogram wyświetli ostrzeżenie, jeśli dla określonego zdarzenia zostanie dodanych więcej niż 10 odbiorniki. Jest to przydatne ustawienie domyślne, które pomaga znaleźć przecieki pamięci. Metoda emitter.setMaxListeners() umożliwia zmodyfikowanie limitu dla tego konkretnego EventEmitter wystąpienia. Wartość można ustawić na Infinity (lub 0), aby wskazać nieograniczoną liczbę odbiorników.

Zwraca odwołanie do elementu EventEmitter, aby można było połączyć wywołania w łańcuch.

function setMaxListeners(n: number): Amqp

Parametry

n

number

Zwraca

Amqp

Dziedziczone z EventEmitter.setMaxListeners

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

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

Parametry

n

number

Liczba nieujemna. Maksymalna liczba odbiorników na EventTarget zdarzenie.

eventTargets

(EventEmitter<DefaultEventMap> | EventTarget)[]

Dziedziczone z EventEmitter.setMaxListeners

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

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

Parametry

error

Error

event

string | symbol

args

AnyRest

Dziedziczone z EventEmitter.__@captureRejectionSymbol@115