ServiceReceiver interface
- Extends
-
Receiver
Métodos
abandon(Message, Callback<Message |
|
complete(Message, Callback<Message |
|
reject(Message, Callback<Message |
Métodos heredados
add |
Alias para |
emit<K>(string | symbol, Any |
Llama sincrónicamente a cada uno de los agentes de escucha registrados para el evento denominado Devuelve
|
event |
Devuelve una matriz que enumera los eventos para los que el emisor ha registrado agentes de escucha. Los valores de la matriz son cadenas o
|
get |
Devuelve el valor máximo actual del agente de escucha para el |
listener |
Devuelve el número de agentes de escucha que escuchan el evento denominado |
listeners<K>(string | symbol) | Devuelve una copia de la matriz de agentes de escucha del evento denominado
|
off<K>(string | symbol, (args: any[]) => void) | Alias para |
on("error |
|
on("message", (msg: Message) => void) | |
on(string, Function) | |
once<K>(string | symbol, (args: any[]) => void) | Agrega una función
Devuelve una referencia al De forma predeterminada, los agentes de escucha de eventos se invocan en el orden en que se agregan. El método
|
prepend |
Agrega la función
Devuelve una referencia al |
prepend |
Agrega una función de
Devuelve una referencia al |
raw |
Devuelve una copia de la matriz de agentes de escucha para el evento denominado
|
remove |
Quita todos los agentes de escucha o los del Es un procedimiento incorrecto quitar agentes de escucha agregados en otro lugar del código, especialmente cuando la instancia de Devuelve una referencia al |
remove |
Quita el
Una vez emitido un evento, se llama a todos los agentes de escucha adjuntos en el momento de emitir en orden. Esto implica que cualquier
Dado que los agentes de escucha se administran mediante una matriz interna, llamar a esto cambiará los índices de posición de cualquier agente de escucha registrado después de el agente de escucha que se va a quitar. Esto no afectará al orden en el que se llama a los agentes de escucha, pero significa que las copias de la matriz del agente de escucha tal y como devuelve el método Cuando se ha agregado una sola función como controlador varias veces para un solo evento (como en el ejemplo siguiente),
Devuelve una referencia al |
set |
De forma predeterminada, Devuelve una referencia al |
[capture |
Detalles del método
abandon(Message, Callback<MessageAbandoned>)
function abandon(message: Message, done?: Callback<MessageAbandoned>)
Parámetros
- message
-
Message
- done
-
Callback<MessageAbandoned>
complete(Message, Callback<MessageCompleted>)
function complete(message: Message, done?: Callback<MessageCompleted>)
Parámetros
- message
-
Message
- done
-
Callback<MessageCompleted>
reject(Message, Callback<MessageRejected>)
function reject(message: Message, done?: Callback<MessageRejected>)
Parámetros
- message
-
Message
- done
-
Callback<MessageRejected>
Detalles de los métodos heredados
addListener<K>(string | symbol, (args: any[]) => void)
Alias para emitter.on(eventName, listener)
.
function addListener<K>(eventName: string | symbol, listener: (args: any[]) => void): ServiceReceiver
Parámetros
- eventName
-
string | symbol
- listener
-
(args: any[]) => void
Devoluciones
Heredado de Receiver.addListener
emit<K>(string | symbol, AnyRest)
Llama sincrónicamente a cada uno de los agentes de escucha registrados para el evento denominado eventName
, en el orden en que se registraron, pasando los argumentos proporcionados a cada uno.
Devuelve true
si el evento tenía agentes de escucha, false
de lo contrario.
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
Devoluciones
boolean
Heredado de Receiver.emit
eventNames()
Devuelve una matriz que enumera los eventos para los que el emisor ha registrado agentes de escucha. Los valores de la matriz son cadenas o Symbol
s.
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)[]
Devoluciones
(string | symbol)[]
Heredado de Receiver.eventNames
getMaxListeners()
Devuelve el valor máximo actual del agente de escucha para el EventEmitter
que se establece mediante emitter.setMaxListeners(n)
o los valores predeterminados en <xref:EventEmitter.defaultMaxListeners>.
function getMaxListeners(): number
Devoluciones
number
Heredado de Receiver.getMaxListeners
listenerCount<K>(string | symbol, Function)
Devuelve el número de agentes de escucha que escuchan el evento denominado eventName
.
Si se proporciona listener
, devolverá cuántas veces se encuentra el agente de escucha en la lista de agentes de escucha del evento.
function listenerCount<K>(eventName: string | symbol, listener?: Function): number
Parámetros
- eventName
-
string | symbol
Nombre del evento que se está escuchando
- listener
-
Function
Función del controlador de eventos
Devoluciones
number
Heredado de Receiver.listenerCount
listeners<K>(string | symbol)
Devuelve una copia de la matriz de agentes de escucha del evento denominado 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
Devoluciones
Function[]
Heredado de Receiver.listeners
off<K>(string | symbol, (args: any[]) => void)
Alias para emitter.removeListener()
.
function off<K>(eventName: string | symbol, listener: (args: any[]) => void): ServiceReceiver
Parámetros
- eventName
-
string | symbol
- listener
-
(args: any[]) => void
Devoluciones
heredado de Receiver.off
on("errorReceived", (err: Error) => void)
function on(type: "errorReceived", func: (err: Error) => void): ServiceReceiver
Parámetros
- type
-
"errorReceived"
- func
-
(err: Error) => void
Devoluciones
heredado de Receiver.on
on("message", (msg: Message) => void)
function on(type: "message", func: (msg: Message) => void): ServiceReceiver
Parámetros
- type
-
"message"
- func
-
(msg: Message) => void
Devoluciones
heredado de Receiver.on
on(string, Function)
function on(type: string, func: Function): ServiceReceiver
Parámetros
- type
-
string
- func
-
Function
Devoluciones
heredado de Receiver.on
once<K>(string | symbol, (args: any[]) => void)
Agrega una funcióneventName
, se quita este agente de escucha y, a continuación, se invoca.
server.once('connection', (stream) => {
console.log('Ah, we have our first user!');
});
Devuelve una referencia al EventEmitter
, para que las llamadas se puedan encadenar.
De forma predeterminada, los agentes de escucha de eventos se invocan en el orden en que se agregan. El método emitter.prependOnceListener()
se puede usar como alternativa para agregar el agente de escucha de eventos al principio de la matriz de agentes de escucha.
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): ServiceReceiver
Parámetros
- eventName
-
string | symbol
Nombre del evento.
- listener
-
(args: any[]) => void
Función de devolución de llamada
Devoluciones
Heredado de Receiver.once
prependListener<K>(string | symbol, (args: any[]) => void)
Agrega la función listener
al que comienza de la matriz de agentes de escucha para el evento denominado eventName
. No se realizan comprobaciones para ver si ya se ha agregado el listener
. Varias llamadas que pasan la misma combinación de eventName
y listener
darán lugar a que se agregue el listener
y se llame varias veces.
server.prependListener('connection', (stream) => {
console.log('someone connected!');
});
Devuelve una referencia al EventEmitter
, para que las llamadas se puedan encadenar.
function prependListener<K>(eventName: string | symbol, listener: (args: any[]) => void): ServiceReceiver
Parámetros
- eventName
-
string | symbol
Nombre del evento.
- listener
-
(args: any[]) => void
Función de devolución de llamada
Devoluciones
heredado de Receiver.prependListener
prependOnceListener<K>(string | symbol, (args: any[]) => void)
Agrega una función deeventName
, se quita este agente de escucha y, a continuación, se invoca.
server.prependOnceListener('connection', (stream) => {
console.log('Ah, we have our first user!');
});
Devuelve una referencia al EventEmitter
, para que las llamadas se puedan encadenar.
function prependOnceListener<K>(eventName: string | symbol, listener: (args: any[]) => void): ServiceReceiver
Parámetros
- eventName
-
string | symbol
Nombre del evento.
- listener
-
(args: any[]) => void
Función de devolución de llamada
Devoluciones
heredado de Receiver.prependOnceListener
rawListeners<K>(string | symbol)
Devuelve una copia de la matriz de agentes de escucha para el evento denominado eventName
, incluidos los contenedores (como los creados 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
Devoluciones
Function[]
heredado de Receiver.rawListeners
removeAllListeners(string | symbol)
Quita todos los agentes de escucha o los del eventName
especificado.
Es un procedimiento incorrecto quitar agentes de escucha agregados en otro lugar del código, especialmente cuando la instancia de EventEmitter
se creó mediante algún otro componente o módulo (por ejemplo, sockets o flujos de archivos).
Devuelve una referencia al EventEmitter
, para que las llamadas se puedan encadenar.
function removeAllListeners(eventName?: string | symbol): ServiceReceiver
Parámetros
- eventName
-
string | symbol
Devoluciones
Heredado de Receiver.removeAllListeners
removeListener<K>(string | symbol, (args: any[]) => void)
Quita el listener
especificado de la matriz del agente de escucha para el evento denominado eventName
.
const callback = (stream) => {
console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);
removeListener()
quitará, como máximo, una instancia de un agente de escucha de la matriz del agente de escucha. Si se ha agregado varias veces alguna escucha única a la matriz del agente de escucha para el eventName
especificado, se debe llamar a removeListener()
varias veces para quitar cada instancia.
Una vez emitido un evento, se llama a todos los agentes de escucha adjuntos en el momento de emitir en orden. Esto implica que cualquier removeListener()
o removeAllListeners()
llama después de emitir y antes de que el último agente de escucha finalice la ejecución no los quitará deemit()
en curso. Los eventos posteriores se comportan según lo previsto.
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
Dado que los agentes de escucha se administran mediante una matriz interna, llamar a esto cambiará los índices de posición de cualquier agente de escucha registrado después de el agente de escucha que se va a quitar. Esto no afectará al orden en el que se llama a los agentes de escucha, pero significa que las copias de la matriz del agente de escucha tal y como devuelve el método emitter.listeners()
deberán volver a crearse.
Cuando se ha agregado una sola función como controlador varias veces para un solo evento (como en el ejemplo siguiente), removeListener()
quitará la instancia agregada más recientemente. En el ejemplo, se quita el agente de escucha once('ping')
:
import { EventEmitter } from 'node:events';
const ee = new EventEmitter();
function pong() {
console.log('pong');
}
ee.on('ping', pong);
ee.once('ping', pong);
ee.removeListener('ping', pong);
ee.emit('ping');
ee.emit('ping');
Devuelve una referencia al EventEmitter
, para que las llamadas se puedan encadenar.
function removeListener<K>(eventName: string | symbol, listener: (args: any[]) => void): ServiceReceiver
Parámetros
- eventName
-
string | symbol
- listener
-
(args: any[]) => void
Devoluciones
Heredado de Receiver.removeListener
setMaxListeners(number)
De forma predeterminada, EventEmitter
s imprimirán una advertencia si se agregan más de 10
agentes de escucha para un evento determinado. Este es un valor predeterminado útil que ayuda a encontrar fugas de memoria. El método emitter.setMaxListeners()
permite modificar el límite para esta instancia de EventEmitter
específica. El valor se puede establecer en Infinity
(o 0
) para indicar un número ilimitado de agentes de escucha.
Devuelve una referencia al EventEmitter
, para que las llamadas se puedan encadenar.
function setMaxListeners(n: number): ServiceReceiver
Parámetros
- n
-
number
Devoluciones
Heredado de Receiver.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
heredado de Receiver.__@captureRejectionSymbol@118