Transport interface
- Extends
-
EventEmitter
Methoden
Geerbte Methoden
add |
Alias für |
emit<K>(string | symbol, Any |
Ruft die einzelnen Listener synchron auf, die für das Ereignis mit dem Namen Gibt
|
event |
Gibt ein Array zurück, das die Ereignisse auflistet, für die der Emitter Listener registriert hat. Die Werte im Array sind Zeichenfolgen oder
|
get |
Gibt den aktuellen Maximallistenerwert für die |
listener |
Gibt die Anzahl der Listener zurück, die auf das Ereignis mit dem Namen |
listeners<K>(string | symbol) | Gibt eine Kopie des Arrays von Listenern für das Ereignis mit dem Namen
|
off<K>(string | symbol, (args: any[]) => void) | Alias für |
on<K>(string | symbol, (args: any[]) => void) | Fügt die
Gibt einen Verweis auf die Standardmäßig werden Ereignislistener in der Reihenfolge aufgerufen, in der sie hinzugefügt werden. Die
|
once<K>(string | symbol, (args: any[]) => void) | Fügt eine einmalige
Gibt einen Verweis auf die Standardmäßig werden Ereignislistener in der Reihenfolge aufgerufen, in der sie hinzugefügt werden. Die
|
prepend |
Fügt die
Gibt einen Verweis auf die |
prepend |
Fügt dem beginnenden des Listenersarrays eine
Gibt einen Verweis auf die |
raw |
Gibt eine Kopie des Arrays von Listenern für das Ereignis mit dem Namen
|
remove |
Entfernt alle Listener oder die der angegebenen Es empfiehlt sich, Listener zu entfernen, die an anderer Stelle im Code hinzugefügt wurden, insbesondere, wenn die Gibt einen Verweis auf die |
remove |
Entfernt die angegebene
Sobald ein Ereignis ausgegeben wird, werden alle listener, die zum Zeitpunkt der Ausstrahlung an sie angefügt sind, in der Reihenfolge aufgerufen. Dies bedeutet, dass alle
Da Listener mithilfe eines internen Arrays verwaltet werden, ändert das Aufrufen die Positionsindizes aller listener, die registriert sind, nachdem der Listener entfernt wurde. Dies wirkt sich nicht auf die Reihenfolge aus, in der Listener aufgerufen werden. Dies bedeutet jedoch, dass alle Kopien des Listenerarrays, wie sie von der Wenn eine einzelne Funktion mehrmals als Handler für ein einzelnes Ereignis (wie im folgenden Beispiel) hinzugefügt wurde, entfernt
Gibt einen Verweis auf die |
set |
Standardmäßig druckt Gibt einen Verweis auf die |
[capture |
Details zur Methode
connect(Callback<Connected>)
function connect(done?: Callback<Connected>)
Parameter
- done
-
Callback<Connected>
disconnect(Callback<Disconnected>)
function disconnect(done: Callback<Disconnected>)
Parameter
- done
-
Callback<Disconnected>
getFeedbackReceiver(Callback<ServiceReceiver>)
function getFeedbackReceiver(done: Callback<ServiceReceiver>)
Parameter
- done
-
Callback<ServiceReceiver>
getFileNotificationReceiver(Callback<ServiceReceiver>)
function getFileNotificationReceiver(done: Callback<ServiceReceiver>)
Parameter
- done
-
Callback<ServiceReceiver>
send(string, Message, Callback<MessageEnqueued>)
function send(deviceId: string, message: Message, done?: Callback<MessageEnqueued>)
Parameter
- deviceId
-
string
- message
-
Message
- done
-
Callback<MessageEnqueued>
Details zur geerbten Methode
addListener<K>(string | symbol, (args: any[]) => void)
Alias für emitter.on(eventName, listener)
.
function addListener<K>(eventName: string | symbol, listener: (args: any[]) => void): Transport
Parameter
- eventName
-
string | symbol
- listener
-
(args: any[]) => void
Gibt zurück
Geerbt von EventEmitter.addListener
emit<K>(string | symbol, AnyRest)
Ruft die einzelnen Listener synchron auf, die für das Ereignis mit dem Namen eventName
registriert wurden, in der Reihenfolge, in der sie registriert wurden, und übergibt die angegebenen Argumente an jedes Ereignis.
Gibt true
zurück, wenn das Ereignis Listener hatte, false
andernfalls.
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
Parameter
- eventName
-
string | symbol
- args
-
AnyRest
Gibt zurück
boolean
von EventEmitter.emit geerbt
eventNames()
Gibt ein Array zurück, das die Ereignisse auflistet, für die der Emitter Listener registriert hat. Die Werte im Array sind Zeichenfolgen oder 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)[]
Gibt zurück
(string | symbol)[]
Geerbt von EventEmitter.eventNames
getMaxListeners()
Gibt den aktuellen Maximallistenerwert für die EventEmitter
zurück, die entweder durch emitter.setMaxListeners(n)
oder standardmäßig auf defaultMaxListenersfestgelegt ist.
function getMaxListeners(): number
Gibt zurück
number
Geerbt von EventEmitter.getMaxListeners
listenerCount<K>(string | symbol, Function)
Gibt die Anzahl der Listener zurück, die auf das Ereignis mit dem Namen eventName
lauschen.
Wenn listener
angegeben wird, wird zurückgegeben, wie oft der Listener in der Liste der Listener des Ereignisses gefunden wird.
function listenerCount<K>(eventName: string | symbol, listener?: Function): number
Parameter
- eventName
-
string | symbol
Der Name des Ereignisses, auf das gewartet wird
- listener
-
Function
Die Ereignishandlerfunktion
Gibt zurück
number
geerbt von EventEmitter.listenerCount
listeners<K>(string | symbol)
Gibt eine Kopie des Arrays von Listenern für das Ereignis mit dem Namen eventName
zurück.
server.on('connection', (stream) => {
console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]
function listeners<K>(eventName: string | symbol): Function[]
Parameter
- eventName
-
string | symbol
Gibt zurück
Function[]
von EventEmitter.listeners geerbt
off<K>(string | symbol, (args: any[]) => void)
Alias für emitter.removeListener()
.
function off<K>(eventName: string | symbol, listener: (args: any[]) => void): Transport
Parameter
- eventName
-
string | symbol
- listener
-
(args: any[]) => void
Gibt zurück
von EventEmitter.off geerbt
on<K>(string | symbol, (args: any[]) => void)
Fügt die listener
-Funktion am Ende des Listenerarrays für das Ereignis mit dem Namen eventName
hinzu. Es werden keine Überprüfungen vorgenommen, um festzustellen, ob die listener
bereits hinzugefügt wurde. Mehrere Aufrufe, die dieselbe Kombination aus eventName
übergeben, und listener
führen dazu, dass die listener
mehrmals hinzugefügt und aufgerufen wird.
server.on('connection', (stream) => {
console.log('someone connected!');
});
Gibt einen Verweis auf die EventEmitter
zurück, sodass Aufrufe verkettet werden können.
Standardmäßig werden Ereignislistener in der Reihenfolge aufgerufen, in der sie hinzugefügt werden. Die emitter.prependListener()
-Methode kann als Alternative zum Hinzufügen des Ereignislisteners zum Anfang des Listenersarrays verwendet werden.
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): Transport
Parameter
- eventName
-
string | symbol
Der Name des Ereignisses.
- listener
-
(args: any[]) => void
Die Rückruffunktion
Gibt zurück
von EventEmitter.on geerbt
once<K>(string | symbol, (args: any[]) => void)
Fügt eine einmaligelistener
-Funktion für das Ereignis mit dem Namen eventName
hinzu. Wenn eventName
das nächste Mal ausgelöst wird, wird dieser Listener entfernt und dann aufgerufen.
server.once('connection', (stream) => {
console.log('Ah, we have our first user!');
});
Gibt einen Verweis auf die EventEmitter
zurück, sodass Aufrufe verkettet werden können.
Standardmäßig werden Ereignislistener in der Reihenfolge aufgerufen, in der sie hinzugefügt werden. Die emitter.prependOnceListener()
-Methode kann als Alternative zum Hinzufügen des Ereignislisteners zum Anfang des Listenersarrays verwendet werden.
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): Transport
Parameter
- eventName
-
string | symbol
Der Name des Ereignisses.
- listener
-
(args: any[]) => void
Die Rückruffunktion
Gibt zurück
von EventEmitter geerbt.once
prependListener<K>(string | symbol, (args: any[]) => void)
Fügt die listener
-Funktion dem beginnenden des Listenersarrays für das Ereignis mit dem Namen eventName
hinzu. Es werden keine Überprüfungen vorgenommen, um festzustellen, ob die listener
bereits hinzugefügt wurde. Mehrere Aufrufe, die dieselbe Kombination aus eventName
übergeben, und listener
führen dazu, dass die listener
mehrmals hinzugefügt und aufgerufen wird.
server.prependListener('connection', (stream) => {
console.log('someone connected!');
});
Gibt einen Verweis auf die EventEmitter
zurück, sodass Aufrufe verkettet werden können.
function prependListener<K>(eventName: string | symbol, listener: (args: any[]) => void): Transport
Parameter
- eventName
-
string | symbol
Der Name des Ereignisses.
- listener
-
(args: any[]) => void
Die Rückruffunktion
Gibt zurück
Geerbt von EventEmitter.prependListener
prependOnceListener<K>(string | symbol, (args: any[]) => void)
Fügt dem beginnenden des Listenersarrays eine listener
eventName
Funktion für das Ereignis hinzu, das genannt wird. Wenn eventName
das nächste Mal ausgelöst wird, wird dieser Listener entfernt und dann aufgerufen.
server.prependOnceListener('connection', (stream) => {
console.log('Ah, we have our first user!');
});
Gibt einen Verweis auf die EventEmitter
zurück, sodass Aufrufe verkettet werden können.
function prependOnceListener<K>(eventName: string | symbol, listener: (args: any[]) => void): Transport
Parameter
- eventName
-
string | symbol
Der Name des Ereignisses.
- listener
-
(args: any[]) => void
Die Rückruffunktion
Gibt zurück
geerbt von EventEmitter.prependOnceListener
rawListeners<K>(string | symbol)
Gibt eine Kopie des Arrays von Listenern für das Ereignis mit dem Namen eventName
zurück, einschließlich aller Wrapper (z. B. von .once()
erstellt).
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[]
Parameter
- eventName
-
string | symbol
Gibt zurück
Function[]
von EventEmitter.rawListeners geerbt
removeAllListeners(string | symbol)
Entfernt alle Listener oder die der angegebenen eventName
.
Es empfiehlt sich, Listener zu entfernen, die an anderer Stelle im Code hinzugefügt wurden, insbesondere, wenn die EventEmitter
Instanz von einer anderen Komponente oder einem anderen Modul (z. B. Sockets oder Dateistreams) erstellt wurde.
Gibt einen Verweis auf die EventEmitter
zurück, sodass Aufrufe verkettet werden können.
function removeAllListeners(eventName?: string | symbol): Transport
Parameter
- eventName
-
string | symbol
Gibt zurück
geerbt von EventEmitter.removeAllListeners
removeListener<K>(string | symbol, (args: any[]) => void)
Entfernt die angegebene listener
aus dem Listenerarray für das Ereignis mit dem Namen eventName
.
const callback = (stream) => {
console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);
removeListener()
entfernt höchstens eine Instanz eines Listeners aus dem Listenerarray. Wenn ein einzelner Listener mehrmals zum Listenerarray für die angegebene eventName
hinzugefügt wurde, muss removeListener()
mehrmals aufgerufen werden, um jede Instanz zu entfernen.
Sobald ein Ereignis ausgegeben wird, werden alle listener, die zum Zeitpunkt der Ausstrahlung an sie angefügt sind, in der Reihenfolge aufgerufen. Dies bedeutet, dass alle removeListener()
oder removeAllListeners()
Aufrufe nach Senden und , bevor die letzte Listenerausführung beendet wird, diese nicht ausemit()
entfernt. Nachfolgende Ereignisse verhalten sich wie erwartet.
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
Da Listener mithilfe eines internen Arrays verwaltet werden, ändert das Aufrufen die Positionsindizes aller listener, die registriert sind, nachdem der Listener entfernt wurde. Dies wirkt sich nicht auf die Reihenfolge aus, in der Listener aufgerufen werden. Dies bedeutet jedoch, dass alle Kopien des Listenerarrays, wie sie von der emitter.listeners()
-Methode zurückgegeben werden, neu erstellt werden müssen.
Wenn eine einzelne Funktion mehrmals als Handler für ein einzelnes Ereignis (wie im folgenden Beispiel) hinzugefügt wurde, entfernt removeListener()
die zuletzt hinzugefügte Instanz. Im Beispiel wird der once('ping')
Listener entfernt:
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');
Gibt einen Verweis auf die EventEmitter
zurück, sodass Aufrufe verkettet werden können.
function removeListener<K>(eventName: string | symbol, listener: (args: any[]) => void): Transport
Parameter
- eventName
-
string | symbol
- listener
-
(args: any[]) => void
Gibt zurück
Geerbt von EventEmitter.removeListener
setMaxListeners(number)
Standardmäßig druckt EventEmitter
s eine Warnung, wenn für ein bestimmtes Ereignis mehr als 10
Listener hinzugefügt werden. Dies ist ein nützlicher Standardwert, der hilft, Speicherverluste zu finden. Mit der emitter.setMaxListeners()
-Methode kann der Grenzwert für diese spezifische EventEmitter
Instanz geändert werden. Der Wert kann auf Infinity
(oder 0
) festgelegt werden, um eine unbegrenzte Anzahl von Listenern anzugeben.
Gibt einen Verweis auf die EventEmitter
zurück, sodass Aufrufe verkettet werden können.
function setMaxListeners(n: number): Transport
Parameter
- n
-
number
Gibt zurück
Geerbt von EventEmitter.setMaxListeners
[captureRejectionSymbol]<K>(Error, string | symbol, AnyRest)
function [captureRejectionSymbol]<K>(error: Error, event: string | symbol, args: AnyRest)
Parameter
- error
-
Error
- event
-
string | symbol
- args
-
AnyRest
geerbt von EventEmitter.__@captureRejectionSymbol@118