Twin class
Un dispositivo gemello è un documento che descrive lo stato di un dispositivo archiviato da un hub IoT di Azure ed è disponibile anche se il dispositivo è offline. Si basa su 3 sezioni:
- Tag: coppie chiave/valore accessibili solo dal lato servizio
- Proprietà desiderate: aggiornata da un servizio e ricevuta dal dispositivo
- Proprietà segnalate: aggiornate dal dispositivo e ricevute dal servizio.
Si noti che, anche se è una possibilità, le proprietà desiderate e segnalate non devono corrispondere e che la logica per sincronizzare queste due raccolte, se necessario, viene lasciata all'utente dell'SDK.
Per altre informazioni, vedere Informazioni sui dispositivi gemelli.
- Extends
-
EventEmitter
Proprietà
desired |
|
error |
|
properties | I dizionari delle proprietà desiderati e segnalati (rispettivamente in |
user |
Proprietà ereditate
capture |
Valore: booleano Modificare l'opzione predefinita |
capture |
Valore: Vedere come scrivere un oggetto personalizzato |
default |
Per impostazione predefinita, è possibile registrare un massimo di Prestare attenzione quando si imposta l'oggetto Questo non è un limite rigido. L'istanza
Il L'avviso generato può essere controllato con |
error |
Questo simbolo deve essere usato per installare un listener solo per gli eventi di monitoraggio L'installazione di un listener usando questo simbolo non modifica il comportamento dopo che viene generato un |
Metodi
get() | |
get(Callback<Twin>) | Ottiene l'intero gemello dal servizio. |
Metodi ereditati
add |
È in ascolto una sola volta dell'evento nell'oggetto L'ascolto dell'evento Questa API consente l'uso Restituisce un oggetto eliminabile in modo che possa essere annullata più facilmente.
|
add |
Alias per |
emit<K>(string | symbol, Any |
Chiama in modo sincrono ognuno dei listener registrati per l'evento denominato Restituisce
|
event |
Restituisce una matrice che elenca gli eventi per i quali l'emettitore ha registrato listener. I valori nella matrice sono stringhe o
|
get |
Restituisce una copia della matrice di listener per l'evento denominato Per Per
|
get |
Restituisce il valore del listener massimo corrente per l'oggetto |
get |
Restituisce la quantità massima di listener attualmente impostata. Per Per
|
listener |
Metodo di classe che restituisce il numero di listener per l'oggetto
|
listener |
Restituisce il numero di listener in ascolto dell'evento denominato |
listeners<K>(string | symbol) | Restituisce una copia della matrice di listener per l'evento denominato
|
off<K>(string | symbol, (args: any[]) => void) | Alias per |
on(Event |
Restituisce un oggetto Un
|
on<K>(string | symbol, (args: any[]) => void) | Aggiunge la
Restituisce un riferimento a Per impostazione predefinita, i listener di eventi vengono richiamati nell'ordine in cui vengono aggiunti. Il
|
once(Event |
Crea un Questo metodo è intenzionalmente generico e funziona con l'interfaccia EventTarget della piattaforma Web, che non ha semantica di eventi speciali
La gestione speciale dell'evento
Un
|
once(Event |
|
once<K>(string | symbol, (args: any[]) => void) | Aggiunge una funzione monouso
Restituisce un riferimento a Per impostazione predefinita, i listener di eventi vengono richiamati nell'ordine in cui vengono aggiunti. Il
|
prepend |
Aggiunge la
Restituisce un riferimento a |
prepend |
Aggiunge una funzione monouso
Restituisce un riferimento a |
raw |
Restituisce una copia della matrice di listener per l'evento denominato
|
remove |
Rimuove tutti i listener o quelli dell'oggetto specificato È consigliabile rimuovere listener aggiunti altrove nel codice, in particolare quando l'istanza Restituisce un riferimento a |
remove |
Rimuove l'oggetto specificato
Una volta generato un evento, tutti i listener collegati al listener al momento dell'emissione vengono chiamati in ordine. Ciò implica che qualsiasi
Poiché i listener vengono gestiti tramite una matrice interna, la chiamata di questa operazione modificherà gli indici di posizione di qualsiasi listener registrato dopo la rimozione del listener. Ciò non influirà sull'ordine in cui vengono chiamati i listener, ma significa che tutte le copie della matrice del listener restituite dal Quando una singola funzione è stata aggiunta più volte come gestore per un singolo evento (come nell'esempio seguente),
Restituisce un riferimento a |
set |
Per impostazione predefinita Restituisce un riferimento a |
set |
|
[capture |
Dettagli proprietà
desiredPath
static desiredPath: string
Valore della proprietà
string
errorEvent
static errorEvent: string
Valore della proprietà
string
properties
I dizionari delle proprietà desiderati e segnalati (rispettivamente in properties.desired
e properties.reported
).
properties: TwinProperties
Valore della proprietà
userRegisteredDesiredPropertiesListener
userRegisteredDesiredPropertiesListener: boolean
Valore della proprietà
boolean
Dettagli proprietà ereditate
captureRejections
Valore: booleano
Modificare l'opzione predefinita captureRejections
in tutti i nuovi EventEmitter
oggetti.
static captureRejections: boolean
Valore della proprietà
boolean
Ereditato da EventEmitter.captureRejections
captureRejectionSymbol
Valore: Symbol.for('nodejs.rejection')
Vedere come scrivere un oggetto personalizzato rejection handler
.
static captureRejectionSymbol: typeof captureRejectionSymbol
Valore della proprietà
typeof captureRejectionSymbol
Ereditato da EventEmitter.captureRejectionSymbol
defaultMaxListeners
Per impostazione predefinita, è possibile registrare un massimo di 10
listener per qualsiasi singolo evento. Questo limite può essere modificato per singole EventEmitter
istanze usando il emitter.setMaxListeners(n)
metodo . Per modificare il valore predefinito per tutte leEventEmitter
istanze, la events.defaultMaxListeners
proprietà può essere usata. Se questo valore non è un numero positivo, viene generato un RangeError
valore.
Prestare attenzione quando si imposta l'oggetto events.defaultMaxListeners
perché la modifica influisce su tutte leEventEmitter
istanze, incluse quelle create prima che venga apportata la modifica. Tuttavia, la chiamata emitter.setMaxListeners(n)
ha ancora la precedenza su events.defaultMaxListeners
.
Questo non è un limite rigido. L'istanza EventEmitter
consentirà di aggiungere più listener, ma restituirà un avviso di traccia a stderr che indica che è stata rilevata una "possibile perdita di memoria EventEmitter". Per qualsiasi singolo EventEmitter
metodo , è possibile usare i emitter.getMaxListeners()
metodi e emitter.setMaxListeners()
per evitare temporaneamente questo avviso:
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));
});
Il --trace-warnings
flag della riga di comando può essere usato per visualizzare la traccia dello stack per tali avvisi.
L'avviso generato può essere controllato con process.on('warning')
e avrà le proprietà aggiuntive emitter
, type
e count
, facendo riferimento all'istanza dell'emittente dell'evento, al nome dell'evento e al numero di listener collegati, rispettivamente.
La proprietà name
è impostata su 'MaxListenersExceededWarning'
.
static defaultMaxListeners: number
Valore della proprietà
number
Ereditato da EventEmitter.defaultMaxListeners
errorMonitor
Questo simbolo deve essere usato per installare un listener solo per gli eventi di monitoraggio 'error'
. I listener installati usando questo simbolo vengono chiamati prima che vengano chiamati i listener regolari 'error'
.
L'installazione di un listener usando questo simbolo non modifica il comportamento dopo che viene generato un 'error'
evento. Pertanto, il processo si arresterà in modo anomalo se non è installato alcun listener regolare 'error'
.
static errorMonitor: typeof errorMonitor
Valore della proprietà
typeof errorMonitor
Ereditato da EventEmitter.errorMonitor
Dettagli metodo
get()
get(Callback<Twin>)
Ottiene l'intero gemello dal servizio.
function get(callback?: Callback<Twin>)
Parametri
- callback
-
Callback<Twin>
funzione facoltativa che deve essere richiamata con il gemello o un errore se il trasporto non riesce a recuperare il gemello.
Dettagli dei metodi ereditati
addAbortListener(AbortSignal, (event: Event) => void)
È in ascolto una sola volta dell'evento nell'oggetto abort
specificato signal
.
L'ascolto dell'evento abort
sui segnali di interruzione non è sicuro e può causare perdite di risorse perché un'altra terza parte con il segnale può chiamare e.stopImmediatePropagation()
. Sfortunatamente Node.js non può modificare questo perché viola lo standard Web. Inoltre, l'API originale semplifica la rimozione dei listener.
Questa API consente l'uso AbortSignal
sicuro di s nelle API Node.js risolvendo questi due problemi ascoltando l'evento in modo che stopImmediatePropagation
non impedisca l'esecuzione del listener.
Restituisce un oggetto eliminabile in modo che possa essere annullata più facilmente.
import { addAbortListener } from 'node:events';
function example(signal) {
let disposable;
try {
signal.addEventListener('abort', (e) => e.stopImmediatePropagation());
disposable = addAbortListener(signal, (e) => {
// Do something when signal is aborted.
});
} finally {
disposable?.[Symbol.dispose]();
}
}
static function addAbortListener(signal: AbortSignal, resource: (event: Event) => void): Disposable
Parametri
- signal
-
AbortSignal
- resource
-
(event: Event) => void
Restituisce
Disposable
Elimina il abort
listener.
Ereditato da EventEmitter.addAbortListener
addListener<K>(string | symbol, (args: any[]) => void)
Alias per emitter.on(eventName, listener)
.
function addListener<K>(eventName: string | symbol, listener: (args: any[]) => void): Twin
Parametri
- eventName
-
string | symbol
- listener
-
(args: any[]) => void
Restituisce
Ereditato da EventEmitter.addListener
emit<K>(string | symbol, AnyRest)
Chiama in modo sincrono ognuno dei listener registrati per l'evento denominato eventName
, nell'ordine in cui sono stati registrati, passando gli argomenti forniti a ognuno.
Restituisce true
se l'evento include listener. In caso contrario, false
.
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
Parametri
- eventName
-
string | symbol
- args
-
AnyRest
Restituisce
boolean
Ereditato da EventEmitter.emit
eventNames()
Restituisce una matrice che elenca gli eventi per i quali l'emettitore ha registrato listener. I valori nella matrice sono stringhe 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)[]
Restituisce
(string | symbol)[]
Ereditato da EventEmitter.eventNames
getEventListeners(EventEmitter<DefaultEventMap> | EventTarget, string | symbol)
Restituisce una copia della matrice di listener per l'evento denominato eventName
.
Per EventEmitter
questo comportamento si comporta esattamente come la chiamata .listeners
all'emettitore.
Per EventTarget
questo è l'unico modo per ottenere i listener di eventi per la destinazione dell'evento. Ciò è utile per scopi di debug e diagnostica.
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[]
Parametri
- emitter
-
EventEmitter<DefaultEventMap> | EventTarget
- name
-
string | symbol
Restituisce
Function[]
Ereditato da EventEmitter.getEventListeners
getMaxListeners()
Restituisce il valore del listener massimo corrente per l'oggetto EventEmitter
che è impostato per impostazione emitter.setMaxListeners(n)
predefinita su defaultMaxListeners.
function getMaxListeners(): number
Restituisce
number
Ereditato da EventEmitter.getMaxListeners
getMaxListeners(EventEmitter<DefaultEventMap> | EventTarget)
Restituisce la quantità massima di listener attualmente impostata.
Per EventEmitter
questo comportamento si comporta esattamente come la chiamata .getMaxListeners
all'emettitore.
Per EventTarget
questo è l'unico modo per ottenere il numero massimo di listener di eventi per la destinazione dell'evento. Se il numero di gestori eventi in un singolo eventTarget supera il set massimo, EventTarget visualizzerà un avviso.
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
Parametri
- emitter
-
EventEmitter<DefaultEventMap> | EventTarget
Restituisce
number
Ereditato da EventEmitter.getMaxListeners
listenerCount(EventEmitter<DefaultEventMap>, string | symbol)
Avviso
Questa API è ora deprecata.
Since v3.2.0 - Use listenerCount
instead.
Metodo di classe che restituisce il numero di listener per l'oggetto eventName
registrato specificato nell'oggetto specificato emitter
.
import { EventEmitter, listenerCount } from 'node:events';
const myEmitter = new EventEmitter();
myEmitter.on('event', () => {});
myEmitter.on('event', () => {});
console.log(listenerCount(myEmitter, 'event'));
// Prints: 2
static function listenerCount(emitter: EventEmitter<DefaultEventMap>, eventName: string | symbol): number
Parametri
- emitter
-
EventEmitter<DefaultEventMap>
Emettitore su cui eseguire una query
- eventName
-
string | symbol
Nome dell'evento
Restituisce
number
Ereditato da EventEmitter.listenerCount
listenerCount<K>(string | symbol, Function)
Restituisce il numero di listener in ascolto dell'evento denominato eventName
.
Se listener
viene specificato, restituirà il numero di volte in cui il listener viene trovato nell'elenco dei listener dell'evento.
function listenerCount<K>(eventName: string | symbol, listener?: Function): number
Parametri
- eventName
-
string | symbol
Nome dell'evento in ascolto
- listener
-
Function
Funzione del gestore eventi
Restituisce
number
Ereditato da EventEmitter.listenerCount
listeners<K>(string | symbol)
Restituisce una copia della matrice di listener per l'evento denominato 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[]
Parametri
- eventName
-
string | symbol
Restituisce
Function[]
Ereditato da EventEmitter.listener
off<K>(string | symbol, (args: any[]) => void)
Alias per emitter.removeListener()
.
function off<K>(eventName: string | symbol, listener: (args: any[]) => void): Twin
Parametri
- eventName
-
string | symbol
- listener
-
(args: any[]) => void
Restituisce
Ereditato da 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
Restituisce un oggetto AsyncIterator
che esegue l'iterazione degli eventName
eventi. Genererà un'eccezione se genera EventEmitter
'error'
. Rimuove tutti i listener quando si esce dal ciclo. L'oggetto value
restituito da ogni iterazione è una matrice composta dagli argomenti dell'evento emesso.
Un AbortSignal
oggetto può essere usato per annullare l'attesa degli eventi:
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>
Parametri
- emitter
-
EventEmitter<DefaultEventMap>
- eventName
-
string
Nome dell'evento in ascolto
- options
-
StaticEventEmitterOptions
Restituisce
AsyncIterableIterator<any>
Oggetto AsyncIterator
che esegue l'iterazione degli eventName
eventi generati dall'oggetto emitter
Ereditato da EventEmitter.on
on<K>(string | symbol, (args: any[]) => void)
Aggiunge la listener
funzione alla fine della matrice listener per l'evento denominato eventName
. Non vengono effettuati controlli per verificare se è già stato aggiunto .listener
Più chiamate che passano la stessa combinazione di eventName
e listener
comportano l'aggiunta listener
e la chiamata, più volte.
server.on('connection', (stream) => {
console.log('someone connected!');
});
Restituisce un riferimento a EventEmitter
, in modo che le chiamate possano essere concatenati.
Per impostazione predefinita, i listener di eventi vengono richiamati nell'ordine in cui vengono aggiunti. Il emitter.prependListener()
metodo può essere usato come alternativa per aggiungere il listener di eventi all'inizio della matrice listener.
import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.on('foo', () => console.log('a'));
myEE.prependListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
// b
// a
function on<K>(eventName: string | symbol, listener: (args: any[]) => void): Twin
Parametri
- eventName
-
string | symbol
Nome dell'evento.
- listener
-
(args: any[]) => void
Funzione di callback
Restituisce
Ereditato da EventEmitter.on
once(EventEmitter<DefaultEventMap>, string | symbol, StaticEventEmitterOptions)
Crea un Promise
oggetto che viene soddisfatto quando genera l'evento EventEmitter
specificato o che viene rifiutato se genera durante l'attesa EventEmitter
'error'
.
Verrà Promise
risolto con una matrice di tutti gli argomenti generati all'evento specificato.
Questo metodo è intenzionalmente generico e funziona con l'interfaccia EventTarget della piattaforma Web, che non ha semantica di eventi speciali'error'
e non è in ascolto dell'evento 'error'
.
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);
}
La gestione speciale dell'evento 'error'
viene usata solo quando events.once()
viene usata per attendere un altro evento. Se events.once()
viene usato per attendere l'evento stessoerror'
, viene considerato come qualsiasi altro tipo di evento senza una gestione speciale:
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
Un AbortSignal
oggetto può essere utilizzato per annullare l'attesa dell'evento:
import { EventEmitter, once } from 'node:events';
const ee = new EventEmitter();
const ac = new AbortController();
async function foo(emitter, event, signal) {
try {
await once(emitter, event, { signal });
console.log('event emitted!');
} catch (error) {
if (error.name === 'AbortError') {
console.error('Waiting for the event was canceled!');
} else {
console.error('There was an error', error.message);
}
}
}
foo(ee, 'foo', ac.signal);
ac.abort(); // Abort waiting for the event
ee.emit('foo'); // Prints: Waiting for the event was canceled!
static function once(emitter: EventEmitter<DefaultEventMap>, eventName: string | symbol, options?: StaticEventEmitterOptions): Promise<any[]>
Parametri
- emitter
-
EventEmitter<DefaultEventMap>
- eventName
-
string | symbol
- options
-
StaticEventEmitterOptions
Restituisce
Promise<any[]>
Ereditato da EventEmitter.once
once(EventTarget, string, StaticEventEmitterOptions)
static function once(emitter: EventTarget, eventName: string, options?: StaticEventEmitterOptions): Promise<any[]>
Parametri
- emitter
-
EventTarget
- eventName
-
string
- options
-
StaticEventEmitterOptions
Restituisce
Promise<any[]>
Ereditato da EventEmitter.once
once<K>(string | symbol, (args: any[]) => void)
Aggiunge una funzione monousolistener
per l'evento denominato eventName
. Al successivo eventName
attivazione, questo listener viene rimosso e quindi richiamato.
server.once('connection', (stream) => {
console.log('Ah, we have our first user!');
});
Restituisce un riferimento a EventEmitter
, in modo che le chiamate possano essere concatenati.
Per impostazione predefinita, i listener di eventi vengono richiamati nell'ordine in cui vengono aggiunti. Il emitter.prependOnceListener()
metodo può essere usato come alternativa per aggiungere il listener di eventi all'inizio della matrice listener.
import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.once('foo', () => console.log('a'));
myEE.prependOnceListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
// b
// a
function once<K>(eventName: string | symbol, listener: (args: any[]) => void): Twin
Parametri
- eventName
-
string | symbol
Nome dell'evento.
- listener
-
(args: any[]) => void
Funzione di callback
Restituisce
Ereditato da EventEmitter.once
prependListener<K>(string | symbol, (args: any[]) => void)
Aggiunge la listener
funzione all'inizio della matrice listener per l'evento denominato eventName
. Non vengono effettuati controlli per verificare se è già stato aggiunto .listener
Più chiamate che passano la stessa combinazione di eventName
e listener
comportano l'aggiunta listener
e la chiamata, più volte.
server.prependListener('connection', (stream) => {
console.log('someone connected!');
});
Restituisce un riferimento a EventEmitter
, in modo che le chiamate possano essere concatenati.
function prependListener<K>(eventName: string | symbol, listener: (args: any[]) => void): Twin
Parametri
- eventName
-
string | symbol
Nome dell'evento.
- listener
-
(args: any[]) => void
Funzione di callback
Restituisce
Ereditato da EventEmitter.prependListener
prependOnceListener<K>(string | symbol, (args: any[]) => void)
Aggiunge una funzione monousolistener
per l'evento denominato eventName
all'inizio della matrice listener. La volta eventName
successiva viene attivata, questo listener viene rimosso e quindi richiamato.
server.prependOnceListener('connection', (stream) => {
console.log('Ah, we have our first user!');
});
Restituisce un riferimento a EventEmitter
, in modo che le chiamate possano essere concatenati.
function prependOnceListener<K>(eventName: string | symbol, listener: (args: any[]) => void): Twin
Parametri
- eventName
-
string | symbol
Nome dell'evento.
- listener
-
(args: any[]) => void
Funzione di callback
Restituisce
Ereditato da EventEmitter.prependOnceListener
rawListeners<K>(string | symbol)
Restituisce una copia della matrice di listener per l'evento denominato eventName
, inclusi eventuali wrapper, ad esempio quelli creati da .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[]
Parametri
- eventName
-
string | symbol
Restituisce
Function[]
Ereditato da EventEmitter.rawListeners
removeAllListeners(string | symbol)
Rimuove tutti i listener o quelli dell'oggetto specificato eventName
.
È consigliabile rimuovere listener aggiunti altrove nel codice, in particolare quando l'istanza EventEmitter
è stata creata da un altro componente o modulo ,ad esempio socket o flussi di file.
Restituisce un riferimento a EventEmitter
, in modo che le chiamate possano essere concatenati.
function removeAllListeners(eventName?: string | symbol): Twin
Parametri
- eventName
-
string | symbol
Restituisce
Ereditato da EventEmitter.removeAllListeners
removeListener<K>(string | symbol, (args: any[]) => void)
Rimuove l'oggetto specificato listener
dalla matrice del listener per l'evento denominato eventName
.
const callback = (stream) => {
console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);
removeListener()
rimuoverà al massimo un'istanza di un listener dalla matrice del listener. Se un listener singolo è stato aggiunto più volte alla matrice del listener per l'oggetto specificato eventName
, removeListener()
è necessario chiamare più volte per rimuovere ogni istanza.
Una volta generato un evento, tutti i listener collegati al listener al momento dell'emissione vengono chiamati in ordine. Ciò implica che qualsiasi removeListener()
chiamata o removeAllListeners()
dopo l'emissione e prima che l'ultimo listener finisca l'esecuzione non li rimuoverà daemit()
in corso. Gli eventi successivi si comportano come 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
Poiché i listener vengono gestiti tramite una matrice interna, la chiamata di questa operazione modificherà gli indici di posizione di qualsiasi listener registrato dopo la rimozione del listener. Ciò non influirà sull'ordine in cui vengono chiamati i listener, ma significa che tutte le copie della matrice del listener restituite dal emitter.listeners()
metodo dovranno essere ricreate.
Quando una singola funzione è stata aggiunta più volte come gestore per un singolo evento (come nell'esempio seguente), removeListener()
rimuoverà l'istanza aggiunta più di recente. Nell'esempio il once('ping')
listener viene rimosso:
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');
Restituisce un riferimento a EventEmitter
, in modo che le chiamate possano essere concatenati.
function removeListener<K>(eventName: string | symbol, listener: (args: any[]) => void): Twin
Parametri
- eventName
-
string | symbol
- listener
-
(args: any[]) => void
Restituisce
Ereditato da EventEmitter.removeListener
setMaxListeners(number)
Per impostazione predefinita EventEmitter
, verrà visualizzato un avviso se vengono aggiunti più 10
listener per un determinato evento. Si tratta di un valore predefinito utile che consente di trovare perdite di memoria. Il emitter.setMaxListeners()
metodo consente di modificare il limite per questa istanza specifica EventEmitter
. Il valore può essere impostato su Infinity
(o 0
) per indicare un numero illimitato di listener.
Restituisce un riferimento a EventEmitter
, in modo che le chiamate possano essere concatenati.
function setMaxListeners(n: number): Twin
Parametri
- n
-
number
Restituisce
Ereditato da 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)[])
Parametri
- n
-
number
Numero non negativo. Numero massimo di listener per EventTarget
evento.
- eventTargets
-
(EventEmitter<DefaultEventMap> | EventTarget)[]
Ereditato da EventEmitter.setMaxListeners
[captureRejectionSymbol]<K>(Error, string | symbol, AnyRest)
function [captureRejectionSymbol]<K>(error: Error, event: string | symbol, args: AnyRest)
Parametri
- error
-
Error
- event
-
string | symbol
- args
-
AnyRest
Ereditato da EventEmitter.__@captureRejectionSymbol@138