Delen via

DeviceTransport interface

  • Referentie
Pakket:
azure-iot-device
Extends

EventEmitter

Methoden

abandon(Message, (err?: Error, results?: MessageAbandoned) => void)
complete(Message, (err?: Error, result?: MessageCompleted) => void)
connect((err?: Error, result?: Connected) => void)
disableC2D((err?: Error) => void)
disableInputMessages((err?: Error) => void)
disableMethods((err?: Error) => void)
disableTwinDesiredPropertiesUpdates((err?: Error) => void)
disconnect((err?: Error, result?: Disconnected) => void)
enableC2D((err?: Error) => void)
enableInputMessages((err?: Error) => void)
enableMethods((err?: Error) => void)
enableTwinDesiredPropertiesUpdates((err?: Error) => void)
getTwin((err?: Error, twin?: TwinProperties) => void)
on("connected", () => void)
on("disconnect", (err?: Error) => void)
on("error", (err: Error) => void)
on("inputMessage", (inputName: string, msg: Message) => void)
on("message", (msg: Message) => void)
on("twinDesiredPropertiesUpdate", (desiredProps: any) => void)
onDeviceMethod(string, (request: MethodMessage, response: DeviceMethodResponse) => void)
reject(Message, (err?: Error, results?: MessageRejected) => void)
sendEvent(Message, (err?: Error, result?: MessageEnqueued) => void)
sendEventBatch(Message[], (err?: Error, result?: MessageEnqueued) => void)
sendMethodResponse(DeviceMethodResponse, (err?: Error, result?: any) => void)
sendOutputEvent(string, Message, (err?: Error, result?: MessageEnqueued) => void)
sendOutputEventBatch(string, Message[], (err?: Error, result?: MessageEnqueued) => void)
setOptions(DeviceClientOptions, (err?: Error, result?: TransportConfigured) => void)
updateSharedAccessSignature(string, (err?: Error, result?: SharedAccessSignatureUpdated) => void)
updateTwinReportedProperties(any, (err?: Error) => void)

Overgenomen methoden

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

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

Roept synchroon alle listeners aan die zijn geregistreerd voor de gebeurtenis met de naam eventName, in de volgorde waarin ze zijn geregistreerd, waarbij de opgegeven argumenten aan elk worden doorgegeven.

Retourneert true als de gebeurtenis listeners had, false anders.

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

Retourneert een matrix met de gebeurtenissen waarvoor de emitter listeners heeft geregistreerd. De waarden in de matrix zijn tekenreeksen of 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) ]
getMaxListeners()

Retourneert de huidige maximale listenerwaarde voor de EventEmitter die is ingesteld door emitter.setMaxListeners(n) of standaard is ingesteld op defaultMaxListeners.
listenerCount<K>(string | symbol, Function)

Retourneert het aantal listeners dat luistert naar de gebeurtenis met de naam eventName. Als listener wordt opgegeven, wordt geretourneerd hoe vaak de listener wordt gevonden in de lijst met listeners van de gebeurtenis.
listeners<K>(string | symbol)

Retourneert een kopie van de matrix met listeners voor de gebeurtenis met de naam 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 voor emitter.removeListener().
once<K>(string | symbol, (args: any[]) => void)

Voegt een eenmaligelistener functie toe voor de gebeurtenis met de naam eventName. De volgende keer eventName dat deze listener wordt geactiveerd, wordt deze verwijderd en vervolgens aangeroepen.

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

Retourneert een verwijzing naar de EventEmitter, zodat aanroepen kunnen worden gekoppeld.

Gebeurtenislisteners worden standaard aangeroepen in de volgorde waarin ze worden toegevoegd. De emitter.prependOnceListener() methode kan worden gebruikt als alternatief om de gebeurtenislistener toe te voegen aan het begin van de listeners-matrix.

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)

Hiermee voegt u de listener functie toe aan het begin van de listeners-matrix voor de gebeurtenis met de naam eventName. Er worden geen controles uitgevoerd om te zien of de listener al is toegevoegd. Meerdere aanroepen die dezelfde combinatie van eventName en listener doorgeven, leiden ertoe dat de listener meerdere keren wordt toegevoegd en aangeroepen.

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

Retourneert een verwijzing naar de EventEmitter, zodat aanroepen kunnen worden gekoppeld.
prependOnceListener<K>(string | symbol, (args: any[]) => void)

Hiermee voegt u een eenmaligelistener functie toe voor de gebeurtenis met de naam eventName aan het begin van de listeners-matrix. De volgende keer eventName dat deze listener wordt geactiveerd, wordt deze verwijderd en vervolgens aangeroepen.

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

Retourneert een verwijzing naar de EventEmitter, zodat aanroepen kunnen worden gekoppeld.
rawListeners<K>(string | symbol)

Retourneert een kopie van de matrix met listeners voor de gebeurtenis met de naam eventName, inclusief eventuele wrappers (zoals die zijn gemaakt door .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)

Hiermee verwijdert u alle listeners of die van de opgegeven eventName.

Het is een slechte gewoonte om listeners te verwijderen die elders in de code zijn toegevoegd, met name wanneer het EventEmitter exemplaar is gemaakt door een ander onderdeel of een andere module (bijvoorbeeld sockets of bestandsstromen).

Retourneert een verwijzing naar de EventEmitter, zodat aanroepen kunnen worden gekoppeld.
removeListener<K>(string | symbol, (args: any[]) => void)

Hiermee verwijdert u de die is opgegeven listener uit de listenermatrix voor de gebeurtenis met de naam eventName.

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

removeListener() verwijdert maximaal één exemplaar van een listener uit de listenermatrix. Als een enkele listener meerdere keren is toegevoegd aan de listenermatrix voor de opgegeven eventName, removeListener() moet meerdere keren worden aangeroepen om elk exemplaar te verwijderen.

Zodra een gebeurtenis is verzonden, worden alle listeners die eraan zijn gekoppeld op het moment van verzenden, op volgorde aangeroepen. Dit houdt in dat aanroepen removeListener() of removeAllListeners() aanroepen na het verzenden en voordat de uitvoering van de laatste listener is voltooid, deze niet verwijderen uitemit() wordt uitgevoerd. Volgende gebeurtenissen gedragen zich zoals verwacht.

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

Omdat listeners worden beheerd met behulp van een interne matrix, worden de positie-indexen gewijzigd van elke listener die is geregistreerd nadat de listener is verwijderd. Dit heeft geen invloed op de volgorde waarin listeners worden aangeroepen, maar het betekent dat kopieën van de listenermatrix zoals geretourneerd door de emitter.listeners() methode opnieuw moeten worden gemaakt.

Wanneer één functie meerdere keren als handler is toegevoegd voor één gebeurtenis (zoals in het onderstaande voorbeeld), removeListener() wordt de meest recent toegevoegde instantie verwijderd. In het voorbeeld is de once('ping') listener verwijderd:

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

Retourneert een verwijzing naar de EventEmitter, zodat aanroepen kunnen worden gekoppeld.
setMaxListeners(number)

EventEmitterStandaard wordt met s een waarschuwing afgedrukt als er meer dan 10 listeners zijn toegevoegd voor een bepaalde gebeurtenis. Dit is een handige standaard die helpt bij het vinden van geheugenlekken. Met de emitter.setMaxListeners() methode kan de limiet worden gewijzigd voor dit specifieke EventEmitter exemplaar. De waarde kan worden ingesteld op Infinity (of 0) om een onbeperkt aantal listeners aan te geven.

Retourneert een verwijzing naar de EventEmitter, zodat aanroepen kunnen worden gekoppeld.
[captureRejectionSymbol]<K>(Error, string | symbol, AnyRest)

Methodedetails

abandon(Message, (err?: Error, results?: MessageAbandoned) => void) 

function abandon(message: Message, done: (err?: Error, results?: MessageAbandoned) => void)

Parameters

message
Message
done

(err?: Error, results?: MessageAbandoned) => void

complete(Message, (err?: Error, result?: MessageCompleted) => void) 

function complete(message: Message, done: (err?: Error, result?: MessageCompleted) => void)

Parameters

message
Message
done

(err?: Error, result?: MessageCompleted) => void

connect((err?: Error, result?: Connected) => void) 

function connect(done: (err?: Error, result?: Connected) => void)

Parameters

done

(err?: Error, result?: Connected) => void

disableC2D((err?: Error) => void) 

function disableC2D(callback: (err?: Error) => void)

Parameters

callback

(err?: Error) => void

disableInputMessages((err?: Error) => void) 

function disableInputMessages(callback: (err?: Error) => void)

Parameters

callback

(err?: Error) => void

disableMethods((err?: Error) => void) 

function disableMethods(callback: (err?: Error) => void)

Parameters

callback

(err?: Error) => void

disableTwinDesiredPropertiesUpdates((err?: Error) => void) 

function disableTwinDesiredPropertiesUpdates(callback: (err?: Error) => void)

Parameters

callback

(err?: Error) => void

disconnect((err?: Error, result?: Disconnected) => void) 

function disconnect(done: (err?: Error, result?: Disconnected) => void)

Parameters

done

(err?: Error, result?: Disconnected) => void

enableC2D((err?: Error) => void) 

function enableC2D(callback: (err?: Error) => void)

Parameters

callback

(err?: Error) => void

enableInputMessages((err?: Error) => void) 

function enableInputMessages(callback: (err?: Error) => void)

Parameters

callback

(err?: Error) => void

enableMethods((err?: Error) => void) 

function enableMethods(callback: (err?: Error) => void)

Parameters

callback

(err?: Error) => void

enableTwinDesiredPropertiesUpdates((err?: Error) => void) 

function enableTwinDesiredPropertiesUpdates(callback: (err?: Error) => void)

Parameters

callback

(err?: Error) => void

getTwin((err?: Error, twin?: TwinProperties) => void) 

function getTwin(callback: (err?: Error, twin?: TwinProperties) => void)

Parameters

callback

(err?: Error, twin?: TwinProperties) => void

on("connected", () => void) 

function on(type: "connected", func: () => void): DeviceTransport

Parameters

type

"connected"

func

() => void

Retouren

DeviceTransport

on("disconnect", (err?: Error) => void) 

function on(type: "disconnect", func: (err?: Error) => void): DeviceTransport

Parameters

type

"disconnect"

func

(err?: Error) => void

Retouren

DeviceTransport

on("error", (err: Error) => void) 

function on(type: "error", func: (err: Error) => void): DeviceTransport

Parameters

type

"error"

func

(err: Error) => void

Retouren

DeviceTransport

on("inputMessage", (inputName: string, msg: Message) => void) 

function on(type: "inputMessage", func: (inputName: string, msg: Message) => void): DeviceTransport

Parameters

type

"inputMessage"

func

(inputName: string, msg: Message) => void

Retouren

DeviceTransport

on("message", (msg: Message) => void) 

function on(type: "message", func: (msg: Message) => void): DeviceTransport

Parameters

type

"message"

func

(msg: Message) => void

Retouren

DeviceTransport

on("twinDesiredPropertiesUpdate", (desiredProps: any) => void) 

function on(type: "twinDesiredPropertiesUpdate", func: (desiredProps: any) => void): DeviceTransport

Parameters

type

"twinDesiredPropertiesUpdate"

func

(desiredProps: any) => void

Retouren

DeviceTransport

onDeviceMethod(string, (request: MethodMessage, response: DeviceMethodResponse) => void) 

function onDeviceMethod(methodName: string, methodCallback: (request: MethodMessage, response: DeviceMethodResponse) => void)

Parameters

methodName

string

methodCallback

(request: MethodMessage, response: DeviceMethodResponse) => void

reject(Message, (err?: Error, results?: MessageRejected) => void) 

function reject(message: Message, done: (err?: Error, results?: MessageRejected) => void)

Parameters

message
Message
done

(err?: Error, results?: MessageRejected) => void

sendEvent(Message, (err?: Error, result?: MessageEnqueued) => void) 

function sendEvent(message: Message, done: (err?: Error, result?: MessageEnqueued) => void)

Parameters

message
Message
done

(err?: Error, result?: MessageEnqueued) => void

sendEventBatch(Message[], (err?: Error, result?: MessageEnqueued) => void) 

function sendEventBatch(messages: Message[], done: (err?: Error, result?: MessageEnqueued) => void)

Parameters

messages

Message[]

done

(err?: Error, result?: MessageEnqueued) => void

sendMethodResponse(DeviceMethodResponse, (err?: Error, result?: any) => void) 

function sendMethodResponse(response: DeviceMethodResponse, done?: (err?: Error, result?: any) => void)

Parameters

response
DeviceMethodResponse
done

(err?: Error, result?: any) => void

sendOutputEvent(string, Message, (err?: Error, result?: MessageEnqueued) => void) 

function sendOutputEvent(outputName: string, message: Message, done: (err?: Error, result?: MessageEnqueued) => void)

Parameters

outputName

string

message
Message
done

(err?: Error, result?: MessageEnqueued) => void

sendOutputEventBatch(string, Message[], (err?: Error, result?: MessageEnqueued) => void) 

function sendOutputEventBatch(outputName: string, messages: Message[], done: (err?: Error, result?: MessageEnqueued) => void)

Parameters

outputName

string

messages

Message[]

done

(err?: Error, result?: MessageEnqueued) => void

setOptions(DeviceClientOptions, (err?: Error, result?: TransportConfigured) => void) 

function setOptions(options: DeviceClientOptions, done: (err?: Error, result?: TransportConfigured) => void)

Parameters

options
DeviceClientOptions
done

(err?: Error, result?: TransportConfigured) => void

updateSharedAccessSignature(string, (err?: Error, result?: SharedAccessSignatureUpdated) => void) 

function updateSharedAccessSignature(sharedAccessSignature: string, done: (err?: Error, result?: SharedAccessSignatureUpdated) => void)

Parameters

sharedAccessSignature

string

done

(err?: Error, result?: SharedAccessSignatureUpdated) => void

updateTwinReportedProperties(any, (err?: Error) => void) 

function updateTwinReportedProperties(patch: any, callback: (err?: Error) => void)

Parameters

patch

any

callback

(err?: Error) => void

Details overgenomen methode

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

Alias voor emitter.on(eventName, listener).

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

Parameters

eventName

string | symbol

listener

(args: any[]) => void

Retouren

DeviceTransport

Overgenomen van EventEmitter.addListener

emit<K>(string | symbol, AnyRest)

Roept synchroon alle listeners aan die zijn geregistreerd voor de gebeurtenis met de naam eventName, in de volgorde waarin ze zijn geregistreerd, waarbij de opgegeven argumenten aan elk worden doorgegeven.

Retourneert true als de gebeurtenis listeners had, false anders.

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

Parameters

eventName

string | symbol

args

AnyRest

Retouren

boolean

Overgenomen van EventEmitter.emit

eventNames()

Retourneert een matrix met de gebeurtenissen waarvoor de emitter listeners heeft geregistreerd. De waarden in de matrix zijn tekenreeksen of 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)[]

Retouren

(string | symbol)[]

Overgenomen van EventEmitter.eventNames

getMaxListeners()

Retourneert de huidige maximale listenerwaarde voor de EventEmitter die is ingesteld door emitter.setMaxListeners(n) of standaard is ingesteld op defaultMaxListeners.

function getMaxListeners(): number

Retouren

number

Overgenomen van EventEmitter.getMaxListeners

listenerCount<K>(string | symbol, Function)

Retourneert het aantal listeners dat luistert naar de gebeurtenis met de naam eventName. Als listener wordt opgegeven, wordt geretourneerd hoe vaak de listener wordt gevonden in de lijst met listeners van de gebeurtenis.

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

Parameters

eventName

string | symbol

De naam van de gebeurtenis die wordt beluisterd

listener

Function

De functie gebeurtenis-handler

Retouren

number

Overgenomen van EventEmitter.listenerCount

listeners<K>(string | symbol)

Retourneert een kopie van de matrix met listeners voor de gebeurtenis met de naam 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[]

Parameters

eventName

string | symbol

Retouren

Function[]

Overgenomen van EventEmitter.listeners

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

Alias voor emitter.removeListener().

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

Parameters

eventName

string | symbol

listener

(args: any[]) => void

Retouren

DeviceTransport

Overgenomen van EventEmitter.off

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

Voegt een eenmaligelistener functie toe voor de gebeurtenis met de naam eventName. De volgende keer eventName dat deze listener wordt geactiveerd, wordt deze verwijderd en vervolgens aangeroepen.

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

Retourneert een verwijzing naar de EventEmitter, zodat aanroepen kunnen worden gekoppeld.

Gebeurtenislisteners worden standaard aangeroepen in de volgorde waarin ze worden toegevoegd. De emitter.prependOnceListener() methode kan worden gebruikt als alternatief om de gebeurtenislistener toe te voegen aan het begin van de listeners-matrix.

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

Parameters

eventName

string | symbol

De naam van de gebeurtenis.

listener

(args: any[]) => void

De callback-functie

Retouren

DeviceTransport

Overgenomen van EventEmitter.once

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

Hiermee voegt u de listener functie toe aan het begin van de listeners-matrix voor de gebeurtenis met de naam eventName. Er worden geen controles uitgevoerd om te zien of de listener al is toegevoegd. Meerdere aanroepen die dezelfde combinatie van eventName en listener doorgeven, leiden ertoe dat de listener meerdere keren wordt toegevoegd en aangeroepen.

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

Retourneert een verwijzing naar de EventEmitter, zodat aanroepen kunnen worden gekoppeld.

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

Parameters

eventName

string | symbol

De naam van de gebeurtenis.

listener

(args: any[]) => void

De callback-functie

Retouren

DeviceTransport

Overgenomen van EventEmitter.prependListener

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

Hiermee voegt u een eenmaligelistener functie toe voor de gebeurtenis met de naam eventName aan het begin van de listeners-matrix. De volgende keer eventName dat deze listener wordt geactiveerd, wordt deze verwijderd en vervolgens aangeroepen.

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

Retourneert een verwijzing naar de EventEmitter, zodat aanroepen kunnen worden gekoppeld.

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

Parameters

eventName

string | symbol

De naam van de gebeurtenis.

listener

(args: any[]) => void

De callback-functie

Retouren

DeviceTransport

Overgenomen van EventEmitter.prependOnceListener

rawListeners<K>(string | symbol)

Retourneert een kopie van de matrix met listeners voor de gebeurtenis met de naam eventName, inclusief eventuele wrappers (zoals die zijn gemaakt door .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[]

Parameters

eventName

string | symbol

Retouren

Function[]

Overgenomen van EventEmitter.rawListeners

removeAllListeners(string | symbol)

Hiermee verwijdert u alle listeners of die van de opgegeven eventName.

Het is een slechte gewoonte om listeners te verwijderen die elders in de code zijn toegevoegd, met name wanneer het EventEmitter exemplaar is gemaakt door een ander onderdeel of een andere module (bijvoorbeeld sockets of bestandsstromen).

Retourneert een verwijzing naar de EventEmitter, zodat aanroepen kunnen worden gekoppeld.

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

Parameters

eventName

string | symbol

Retouren

DeviceTransport

Overgenomen van EventEmitter.removeAllListeners

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

Hiermee verwijdert u de die is opgegeven listener uit de listenermatrix voor de gebeurtenis met de naam eventName.

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

removeListener() verwijdert maximaal één exemplaar van een listener uit de listenermatrix. Als een enkele listener meerdere keren is toegevoegd aan de listenermatrix voor de opgegeven eventName, removeListener() moet meerdere keren worden aangeroepen om elk exemplaar te verwijderen.

Zodra een gebeurtenis is verzonden, worden alle listeners die eraan zijn gekoppeld op het moment van verzenden, op volgorde aangeroepen. Dit houdt in dat aanroepen removeListener() of removeAllListeners() aanroepen na het verzenden en voordat de uitvoering van de laatste listener is voltooid, deze niet verwijderen uitemit() wordt uitgevoerd. Volgende gebeurtenissen gedragen zich zoals verwacht.

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

Omdat listeners worden beheerd met behulp van een interne matrix, worden de positie-indexen gewijzigd van elke listener die is geregistreerd nadat de listener is verwijderd. Dit heeft geen invloed op de volgorde waarin listeners worden aangeroepen, maar het betekent dat kopieën van de listenermatrix zoals geretourneerd door de emitter.listeners() methode opnieuw moeten worden gemaakt.

Wanneer één functie meerdere keren als handler is toegevoegd voor één gebeurtenis (zoals in het onderstaande voorbeeld), removeListener() wordt de meest recent toegevoegde instantie verwijderd. In het voorbeeld is de once('ping') listener verwijderd:

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

Retourneert een verwijzing naar de EventEmitter, zodat aanroepen kunnen worden gekoppeld.

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

Parameters

eventName

string | symbol

listener

(args: any[]) => void

Retouren

DeviceTransport

Overgenomen van EventEmitter.removeListener

setMaxListeners(number)

EventEmitterStandaard wordt met s een waarschuwing afgedrukt als er meer dan 10 listeners zijn toegevoegd voor een bepaalde gebeurtenis. Dit is een handige standaard die helpt bij het vinden van geheugenlekken. Met de emitter.setMaxListeners() methode kan de limiet worden gewijzigd voor dit specifieke EventEmitter exemplaar. De waarde kan worden ingesteld op Infinity (of 0) om een onbeperkt aantal listeners aan te geven.

Retourneert een verwijzing naar de EventEmitter, zodat aanroepen kunnen worden gekoppeld.

function setMaxListeners(n: number): DeviceTransport

Parameters

n

number

Retouren

DeviceTransport

Overgenomen van EventEmitter.setMaxListeners

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

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

Parameters

error

Error

event

string | symbol

args

AnyRest

Overgenomen van EventEmitter.__@captureRejectionSymbol@145