IotEdgeAuthenticationProvider class
Zapewnia implementację AuthenticationProvider
, która deleguje generowanie tokenów do elementu iotedged. Ta implementacja ma być używana podczas korzystania z klienta modułu z usługą Azure IoT Edge.
Ten typ dziedziczy z SharedAccessKeyAuthenticationProvider
i jest funkcjonalnie identyczny z tym typem, z wyjątkiem części generowania tokenu, którą zastępuje przez zaimplementowanie _sign
metody.
- Extends
Właściwości dziedziczone
capture |
Wartość: wartość logiczna Zmień opcję domyślną |
capture |
Wartość: Zobacz, jak napisać niestandardowy |
default |
Domyślnie dla każdego pojedynczego Zachowaj ostrożność podczas ustawiania Nie jest to sztywny limit. Wystąpienie
Flaga Emitowane ostrzeżenie można sprawdzić za pomocą |
error |
Ten symbol służy do instalowania odbiornika tylko do monitorowania Instalowanie odbiornika przy użyciu tego symbolu nie zmienia zachowania po |
type |
Metody
get |
Metody dziedziczone
add |
Nasłuchuje raz zdarzenia
Ten interfejs API umożliwia bezpieczne korzystanie z Zwraca jednorazowy element, aby można było go łatwiej anulować.
|
add |
Alias dla . |
emit<K>(string | symbol, Any |
Synchronicznie wywołuje każdy odbiornik zarejestrowany dla zdarzenia o nazwie Zwraca
|
event |
Zwraca tablicę zawierającą listę zdarzeń, dla których emiter zarejestrował odbiorniki. Wartości w tablicy to ciągi lub
|
from |
Tworzy nowe |
get |
|
get |
Ta metoda jest używana przez transporty do pobierania najnowszych poświadczeń urządzenia w postaci |
get |
Zwraca kopię tablicy odbiorników dla zdarzenia o nazwie W przypadku Dla
|
get |
Zwraca bieżącą wartość maksymalnego odbiornika, |
get |
Zwraca obecnie ustawioną maksymalną ilość odbiorników. W przypadku Dla
|
listener |
Metoda klasy zwracająca liczbę odbiorników dla danej
|
listener |
Zwraca liczbę odbiorników nasłuchujących zdarzenia o nazwie |
listeners<K>(string | symbol) | Zwraca kopię tablicy odbiorników dla zdarzenia o nazwie
|
off<K>(string | symbol, (args: any[]) => void) | Alias dla . |
on(Event |
Zwraca wartość, która Element
|
on<K>(string | symbol, (args: any[]) => void) |
Zwraca odwołanie do elementu Domyślnie odbiorniki zdarzeń są wywoływane w kolejności, w której są dodawane. Metoda
|
once(Event |
Ta metoda jest celowo ogólna i współpracuje z interfejsem platformy internetowej EventTarget , który nie ma specjalnej
Specjalna obsługa
Element
|
once(Event |
|
once<K>(string | symbol, (args: any[]) => void) | Dodaje funkcję jednorazową
Zwraca odwołanie do elementu Domyślnie odbiorniki zdarzeń są wywoływane w kolejności, w której są dodawane. Metoda
|
prepend |
Zwraca odwołanie do elementu |
prepend |
Dodaje jednorazową
Zwraca odwołanie do elementu |
raw |
Zwraca kopię tablicy odbiorników dla zdarzenia o nazwie
|
remove |
Usuwa wszystkie odbiorniki lub te z określonego Niewłaściwą praktyką jest usunięcie odbiorników dodanych w innym miejscu w kodzie, szczególnie w przypadku Zwraca odwołanie do elementu |
remove |
Usuwa określony
Po emitowaniu zdarzenia wszystkie odbiorniki dołączone do niego w momencie emitowania są wywoływane w kolejności. Oznacza to, że wszystkie
Ponieważ odbiorniki są zarządzane przy użyciu tablicy wewnętrznej, wywołanie tej funkcji spowoduje zmianę indeksów pozycji każdego odbiornika zarejestrowanego po usunięciu odbiornika. Nie będzie to miało wpływu na kolejność wywoływanych odbiorników, ale oznacza to, że wszystkie kopie tablicy odbiorników zwrócone przez Jeśli pojedyncza funkcja została dodana jako procedura obsługi wiele razy dla pojedynczego zdarzenia (jak w poniższym przykładzie),
Zwraca odwołanie do elementu |
set |
Domyślnie Zwraca odwołanie do elementu |
set |
|
set |
Ta metoda umożliwia obiektowi wywołującego ustawienie nowych wartości na potrzeby odnawiania uwierzytelniania. Ta funkcja jest wykonywana synchronicznie, ale spowoduje asynchroniczne wykonywanie akcji. Jeśli dostawca już odnawia token, na przykład — jeśli połączenie sieciowe zostało nawiązane, wywołanie tej funkcji spowoduje niemal natychmiastowe wznowienie. W zależności od protokołu może to spowodować rozłączenie i ponowne nawiązanie połączenia. Jeśli jednak odnowienia nie są obecnie wykonywane, po prostu zapiszemy nowe wartości do późniejszego użycia. |
stop() | Zatrzymuje czasomierz używany do odnawiania tokenu SAS. |
[capture |
Szczegóły właściwości dziedziczonej
captureRejections
Wartość: wartość logiczna
Zmień opcję domyślną captureRejections
dla wszystkich nowych EventEmitter
obiektów.
static captureRejections: boolean
Wartość właściwości
boolean
Dziedziczone zsharedAccessKeyAuthenticationProvider.captureRejections
captureRejectionSymbol
Wartość: Symbol.for('nodejs.rejection')
Zobacz, jak napisać niestandardowy rejection handler
element .
static captureRejectionSymbol: typeof captureRejectionSymbol
Wartość właściwości
typeof captureRejectionSymbol
Dziedziczone zsharedAccessKeyAuthenticationProvider.captureRejectionSymbol
defaultMaxListeners
Domyślnie dla każdego pojedynczego 10
zdarzenia można zarejestrować maksymalnie odbiorniki. Ten limit można zmienić dla poszczególnych EventEmitter
wystąpień przy użyciu emitter.setMaxListeners(n)
metody . Aby zmienić wartość domyślną dla wszystkichEventEmitter
wystąpień, events.defaultMaxListeners
można użyć właściwości . Jeśli ta wartość nie jest liczbą dodatnią, RangeError
zwracana jest wartość .
Zachowaj ostrożność podczas ustawiania events.defaultMaxListeners
elementu , ponieważ zmiana ma wpływ na wszystkieEventEmitter
wystąpienia, w tym te utworzone przed wprowadzeniem zmiany. Jednak wywołanie emitter.setMaxListeners(n)
nadal ma pierwszeństwo przed events.defaultMaxListeners
.
Nie jest to sztywny limit. Wystąpienie EventEmitter
umożliwi dodanie większej liczby odbiorników, ale wyświetli ostrzeżenie śledzenia do stderr wskazujące, że wykryto "możliwy wyciek pamięci eventEmitter". W przypadku dowolnego pojedynczego EventEmitter
emitter.getMaxListeners()
elementu można użyć metod iemitter.setMaxListeners()
, aby tymczasowo uniknąć tego ostrzeżenia:
import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.setMaxListeners(emitter.getMaxListeners() + 1);
emitter.once('event', () => {
// do stuff
emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0));
});
Flaga --trace-warnings
wiersza polecenia może służyć do wyświetlania śladu stosu dla takich ostrzeżeń.
Emitowane ostrzeżenie można sprawdzić za pomocą process.on('warning')
elementu i będzie mieć dodatkowe emitter
właściwości , type
i count
odwołujące się do wystąpienia emitera zdarzeń, nazwy zdarzenia i liczby dołączonych odbiorników, odpowiednio.
Jej name
właściwość jest ustawiona na 'MaxListenersExceededWarning'
wartość .
static defaultMaxListeners: number
Wartość właściwości
number
Dziedziczone zSharedAccessKeyAuthenticationProvider.defaultMaxListeners
errorMonitor
Ten symbol służy do instalowania odbiornika tylko do monitorowania 'error'
zdarzeń. Odbiorniki zainstalowane przy użyciu tego symbolu są wywoływane przed wywołaniami zwykłych 'error'
odbiorników.
Instalowanie odbiornika przy użyciu tego symbolu nie zmienia zachowania po 'error'
emitowaniu zdarzenia. W związku z tym proces będzie nadal ulegać awarii, jeśli nie zainstalowano zwykłego 'error'
odbiornika.
static errorMonitor: typeof errorMonitor
Wartość właściwości
typeof errorMonitor
Dziedziczone zsharedAccessKeyAuthenticationProvider.errorMonitor
type
type: AuthenticationType
Wartość właściwości
AuthenticationType
Dziedziczone zSharedAccessKeyAuthenticationProvider.type
Szczegóły metody
getTrustBundle((err?: Error, ca?: string) => void)
function getTrustBundle(callback: (err?: Error, ca?: string) => void)
Parametry
- callback
-
(err?: Error, ca?: string) => void
Szczegóły metody dziedziczonej
addAbortListener(AbortSignal, (event: Event) => void)
Nasłuchuje raz zdarzenia abort
w podanym signal
obiekcie .
abort
Nasłuchiwanie zdarzenia na sygnałach przerwania jest niebezpieczne i może prowadzić do wycieków zasobów, ponieważ inna strona z sygnałem może wywołać e.stopImmediatePropagation()
metodę . Niestety Node.js nie może to zmienić, ponieważ naruszałoby standard sieci Web. Ponadto oryginalny interfejs API ułatwia zapomnienie o usuwaniu odbiorników.
Ten interfejs API umożliwia bezpieczne korzystanie z AbortSignal
usług s w interfejsach API Node.js przez rozwiązanie tych dwóch problemów przez nasłuchiwanie zdarzenia, które stopImmediatePropagation
nie uniemożliwia uruchamiania odbiornika.
Zwraca jednorazowy element, aby można było go łatwiej anulować.
import { addAbortListener } from 'node:events';
function example(signal) {
let disposable;
try {
signal.addEventListener('abort', (e) => e.stopImmediatePropagation());
disposable = addAbortListener(signal, (e) => {
// Do something when signal is aborted.
});
} finally {
disposable?.[Symbol.dispose]();
}
}
static function addAbortListener(signal: AbortSignal, resource: (event: Event) => void): Disposable
Parametry
- signal
-
AbortSignal
- resource
-
(event: Event) => void
Zwraca
Disposable
Jednorazowy abort
, który usuwa odbiornik.
Dziedziczone zsharedAccessKeyAuthenticationProvider.addAbortListener
addListener<K>(string | symbol, (args: any[]) => void)
Alias dla .emitter.on(eventName, listener)
function addListener<K>(eventName: string | symbol, listener: (args: any[]) => void): IotEdgeAuthenticationProvider
Parametry
- eventName
-
string | symbol
- listener
-
(args: any[]) => void
Zwraca
Dziedziczone zsharedAccessKeyAuthenticationProvider.addListener
emit<K>(string | symbol, AnyRest)
Synchronicznie wywołuje każdy odbiornik zarejestrowany dla zdarzenia o nazwie eventName
, w kolejności, w której zostały zarejestrowane, przekazując podane argumenty do każdego z nich.
Zwraca true
wartość , jeśli zdarzenie miało odbiorniki, false
w przeciwnym razie.
import { EventEmitter } from 'node:events';
const myEmitter = new EventEmitter();
// First listener
myEmitter.on('event', function firstListener() {
console.log('Helloooo! first listener');
});
// Second listener
myEmitter.on('event', function secondListener(arg1, arg2) {
console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
});
// Third listener
myEmitter.on('event', function thirdListener(...args) {
const parameters = args.join(', ');
console.log(`event with parameters ${parameters} in third listener`);
});
console.log(myEmitter.listeners('event'));
myEmitter.emit('event', 1, 2, 3, 4, 5);
// Prints:
// [
// [Function: firstListener],
// [Function: secondListener],
// [Function: thirdListener]
// ]
// Helloooo! first listener
// event with parameters 1, 2 in second listener
// event with parameters 1, 2, 3, 4, 5 in third listener
function emit<K>(eventName: string | symbol, args: AnyRest): boolean
Parametry
- eventName
-
string | symbol
- args
-
AnyRest
Zwraca
boolean
Dziedziczone zSharedAccessKeyAuthenticationProvider.emit
eventNames()
Zwraca tablicę zawierającą listę zdarzeń, dla których emiter zarejestrował odbiorniki. Wartości w tablicy to ciągi lub 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)[]
Zwraca
(string | symbol)[]
Dziedziczone zSharedAccessKeyAuthenticationProvider.eventNames
fromConnectionString(string, number, number)
Tworzy nowe SharedAccessKeyAuthenticationProvider
na podstawie parametry połączenia
static function fromConnectionString(connectionString: string, tokenValidTimeInSeconds?: number, tokenRenewalMarginInSeconds?: number): SharedAccessKeyAuthenticationProvider
Parametry
- connectionString
-
string
Urządzenie parametry połączenia zawierające wymagane parametry uwierzytelniania w centrum IoT Hub.
- tokenValidTimeInSeconds
-
number
[opcjonalnie] Liczba sekund, dla których token ma być prawidłowy.
- tokenRenewalMarginInSeconds
-
number
[opcjonalnie] Liczba sekund przed końcem okresu ważności, w którym SharedAccessKeyAuthenticationProvider
element powinien odnowić token.
Zwraca
Dziedziczone zSharedAccessKeyAuthenticationProvider.fromConnectionString
getDeviceCredentials()
function getDeviceCredentials(): Promise<TransportConfig>
Zwraca
Promise<TransportConfig>
Dziedziczone zsharedAccessKeyAuthenticationProvider.getDeviceCredentials
getDeviceCredentials(Callback<TransportConfig>)
Ta metoda jest używana przez transporty do pobierania najnowszych poświadczeń urządzenia w postaci TransportConfig
obiektu.
function getDeviceCredentials(callback?: Callback<TransportConfig>)
Parametry
- callback
-
Callback<TransportConfig>
opcjonalna funkcja, która zostanie wywołana z błędem lub zestawem poświadczeń urządzenia, których można użyć do uwierzytelniania w centrum IoT.
Dziedziczone zsharedAccessKeyAuthenticationProvider.getDeviceCredentials
getEventListeners(EventEmitter<DefaultEventMap> | EventTarget, string | symbol)
Zwraca kopię tablicy odbiorników dla zdarzenia o nazwie eventName
.
W przypadku EventEmitter
elementu działa to dokładnie tak samo jak wywołanie .listeners
elementu emitującego.
Dla EventTarget
s jest to jedyny sposób, aby uzyskać odbiorniki zdarzeń dla obiektu docelowego zdarzenia. Jest to przydatne do debugowania i diagnostyki.
import { getEventListeners, EventEmitter } from 'node:events';
{
const ee = new EventEmitter();
const listener = () => console.log('Events are fun');
ee.on('foo', listener);
console.log(getEventListeners(ee, 'foo')); // [ [Function: listener] ]
}
{
const et = new EventTarget();
const listener = () => console.log('Events are fun');
et.addEventListener('foo', listener);
console.log(getEventListeners(et, 'foo')); // [ [Function: listener] ]
}
static function getEventListeners(emitter: EventEmitter<DefaultEventMap> | EventTarget, name: string | symbol): Function[]
Parametry
- emitter
-
EventEmitter<DefaultEventMap> | EventTarget
- name
-
string | symbol
Zwraca
Function[]
Dziedziczone zelementu SharedAccessKeyAuthenticationProvider.getEventListeners
getMaxListeners()
Zwraca bieżącą wartość maksymalnego odbiornika, EventEmitter
która jest ustawiona domyślnie emitter.setMaxListeners(n)
lub domyślnie ustawiona na wartość defaultMaxListeners.
function getMaxListeners(): number
Zwraca
number
Dziedziczone zelementu SharedAccessKeyAuthenticationProvider.getMaxListeners
getMaxListeners(EventEmitter<DefaultEventMap> | EventTarget)
Zwraca obecnie ustawioną maksymalną ilość odbiorników.
W przypadku EventEmitter
elementu działa to dokładnie tak samo jak wywołanie .getMaxListeners
elementu emitującego.
Dla EventTarget
s jest to jedyny sposób, aby uzyskać maksymalną liczbę odbiorników zdarzeń dla miejsca docelowego zdarzenia. Jeśli liczba procedur obsługi zdarzeń w pojedynczym obiekcie EventTarget przekracza maksymalny zestaw, usługa EventTarget wyświetli ostrzeżenie.
import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';
{
const ee = new EventEmitter();
console.log(getMaxListeners(ee)); // 10
setMaxListeners(11, ee);
console.log(getMaxListeners(ee)); // 11
}
{
const et = new EventTarget();
console.log(getMaxListeners(et)); // 10
setMaxListeners(11, et);
console.log(getMaxListeners(et)); // 11
}
static function getMaxListeners(emitter: EventEmitter<DefaultEventMap> | EventTarget): number
Parametry
- emitter
-
EventEmitter<DefaultEventMap> | EventTarget
Zwraca
number
Dziedziczone zelementu SharedAccessKeyAuthenticationProvider.getMaxListeners
listenerCount(EventEmitter<DefaultEventMap>, string | symbol)
Ostrzeżenie
Ten interfejs API jest już przestarzały.
Since v3.2.0 - Use listenerCount
instead.
Metoda klasy zwracająca liczbę odbiorników dla danej eventName
zarejestrowanej na danym emitter
obiekcie .
import { EventEmitter, listenerCount } from 'node:events';
const myEmitter = new EventEmitter();
myEmitter.on('event', () => {});
myEmitter.on('event', () => {});
console.log(listenerCount(myEmitter, 'event'));
// Prints: 2
static function listenerCount(emitter: EventEmitter<DefaultEventMap>, eventName: string | symbol): number
Parametry
- emitter
-
EventEmitter<DefaultEventMap>
Emiter do wykonywania zapytania
- eventName
-
string | symbol
Nazwa zdarzenia
Zwraca
number
Dziedziczone zsharedAccessKeyAuthenticationProvider.listenerCount
listenerCount<K>(string | symbol, Function)
Zwraca liczbę odbiorników nasłuchujących zdarzenia o nazwie eventName
.
Jeśli listener
zostanie podana, zostanie zwrócona liczba wystąpień odbiornika na liście odbiorników zdarzenia.
function listenerCount<K>(eventName: string | symbol, listener?: Function): number
Parametry
- eventName
-
string | symbol
Nazwa zdarzenia, dla których jest nasłuchiwane
- listener
-
Function
Funkcja obsługi zdarzeń
Zwraca
number
Dziedziczone zsharedAccessKeyAuthenticationProvider.listenerCount
listeners<K>(string | symbol)
Zwraca kopię tablicy odbiorników dla zdarzenia o nazwie eventName
.
server.on('connection', (stream) => {
console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]
function listeners<K>(eventName: string | symbol): Function[]
Parametry
- eventName
-
string | symbol
Zwraca
Function[]
Dziedziczone zsharedAccessKeyAuthenticationProvider.listeners
off<K>(string | symbol, (args: any[]) => void)
Alias dla .emitter.removeListener()
function off<K>(eventName: string | symbol, listener: (args: any[]) => void): IotEdgeAuthenticationProvider
Parametry
- eventName
-
string | symbol
- listener
-
(args: any[]) => void
Zwraca
Dziedziczone zSharedAccessKeyAuthenticationProvider.off
on(EventEmitter<DefaultEventMap>, string, StaticEventEmitterOptions)
import { on, EventEmitter } from 'node:events';
import process from 'node:process';
const ee = new EventEmitter();
// Emit later on
process.nextTick(() => {
ee.emit('foo', 'bar');
ee.emit('foo', 42);
});
for await (const event of on(ee, 'foo')) {
// The execution of this inner block is synchronous and it
// processes one event at a time (even with await). Do not use
// if concurrent execution is required.
console.log(event); // prints ['bar'] [42]
}
// Unreachable here
Zwraca wartość, która AsyncIterator
iteruje eventName
zdarzenia. Spowoduje to zgłoszenie, jeśli emituje 'error'
wartość EventEmitter
. Usuwa wszystkie odbiorniki podczas zamykania pętli. Zwracana value
przez każdą iterację jest tablicą składającą się z emitowanych argumentów zdarzeń.
Element AbortSignal
może służyć do anulowania oczekiwania na zdarzenia:
import { on, EventEmitter } from 'node:events';
import process from 'node:process';
const ac = new AbortController();
(async () => {
const ee = new EventEmitter();
// Emit later on
process.nextTick(() => {
ee.emit('foo', 'bar');
ee.emit('foo', 42);
});
for await (const event of on(ee, 'foo', { signal: ac.signal })) {
// The execution of this inner block is synchronous and it
// processes one event at a time (even with await). Do not use
// if concurrent execution is required.
console.log(event); // prints ['bar'] [42]
}
// Unreachable here
})();
process.nextTick(() => ac.abort());
static function on(emitter: EventEmitter<DefaultEventMap>, eventName: string, options?: StaticEventEmitterOptions): AsyncIterableIterator<any>
Parametry
- emitter
-
EventEmitter<DefaultEventMap>
- eventName
-
string
Nazwa zdarzenia, dla których jest nasłuchiwane
- options
-
StaticEventEmitterOptions
Zwraca
AsyncIterableIterator<any>
Element AsyncIterator
, który iteruje eventName
zdarzenia emitowane przez emitter
Dziedziczone zSharedAccessKeyAuthenticationProvider.on
on<K>(string | symbol, (args: any[]) => void)
listener
Dodaje funkcję na końcu tablicy odbiorników dla zdarzenia o nazwie eventName
. Nie są sprawdzane, czy listener
element został już dodany. Wiele wywołań przekazujących eventName
tę samą kombinację elementów i listener
spowoduje listener
dodanie i wywołanie wielu razy.
server.on('connection', (stream) => {
console.log('someone connected!');
});
Zwraca odwołanie do elementu EventEmitter
, aby można było połączyć wywołania w łańcuch.
Domyślnie odbiorniki zdarzeń są wywoływane w kolejności, w której są dodawane. Metoda emitter.prependListener()
może służyć jako alternatywa, aby dodać odbiornik zdarzeń na początku tablicy odbiorników.
import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.on('foo', () => console.log('a'));
myEE.prependListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
// b
// a
function on<K>(eventName: string | symbol, listener: (args: any[]) => void): IotEdgeAuthenticationProvider
Parametry
- eventName
-
string | symbol
Nazwa zdarzenia.
- listener
-
(args: any[]) => void
Funkcja wywołania zwrotnego
Zwraca
Dziedziczone zSharedAccessKeyAuthenticationProvider.on
once(EventEmitter<DefaultEventMap>, string | symbol, StaticEventEmitterOptions)
Promise
Tworzy obiekt, który jest spełniony, gdy EventEmitter
emituje dane zdarzenie lub jest odrzucany, jeśli EventEmitter
emituje 'error'
podczas oczekiwania.
Funkcja Promise
rozwiąże problem z tablicą wszystkich argumentów emitowanych do danego zdarzenia.
Ta metoda jest celowo ogólna i współpracuje z interfejsem platformy internetowej EventTarget , który nie ma specjalnej'error'
semantyki zdarzeń i nie nasłuchuje 'error'
zdarzenia.
import { once, EventEmitter } from 'node:events';
import process from 'node:process';
const ee = new EventEmitter();
process.nextTick(() => {
ee.emit('myevent', 42);
});
const [value] = await once(ee, 'myevent');
console.log(value);
const err = new Error('kaboom');
process.nextTick(() => {
ee.emit('error', err);
});
try {
await once(ee, 'myevent');
} catch (err) {
console.error('error happened', err);
}
Specjalna obsługa 'error'
zdarzenia jest używana tylko wtedy, gdy events.once()
jest używana do oczekiwania na inne zdarzenie. Jeśli events.once()
jest używany do oczekiwania na samo zdarzenie ,error'
jest traktowany jako dowolny inny rodzaj zdarzenia bez specjalnej obsługi:
import { EventEmitter, once } from 'node:events';
const ee = new EventEmitter();
once(ee, 'error')
.then(([err]) => console.log('ok', err.message))
.catch((err) => console.error('error', err.message));
ee.emit('error', new Error('boom'));
// Prints: ok boom
Element AbortSignal
może służyć do anulowania oczekiwania na zdarzenie:
import { EventEmitter, once } from 'node:events';
const ee = new EventEmitter();
const ac = new AbortController();
async function foo(emitter, event, signal) {
try {
await once(emitter, event, { signal });
console.log('event emitted!');
} catch (error) {
if (error.name === 'AbortError') {
console.error('Waiting for the event was canceled!');
} else {
console.error('There was an error', error.message);
}
}
}
foo(ee, 'foo', ac.signal);
ac.abort(); // Abort waiting for the event
ee.emit('foo'); // Prints: Waiting for the event was canceled!
static function once(emitter: EventEmitter<DefaultEventMap>, eventName: string | symbol, options?: StaticEventEmitterOptions): Promise<any[]>
Parametry
- emitter
-
EventEmitter<DefaultEventMap>
- eventName
-
string | symbol
- options
-
StaticEventEmitterOptions
Zwraca
Promise<any[]>
Dziedziczone zSharedAccessKeyAuthenticationProvider.once
once(EventTarget, string, StaticEventEmitterOptions)
static function once(emitter: EventTarget, eventName: string, options?: StaticEventEmitterOptions): Promise<any[]>
Parametry
- emitter
-
EventTarget
- eventName
-
string
- options
-
StaticEventEmitterOptions
Zwraca
Promise<any[]>
Dziedziczone zSharedAccessKeyAuthenticationProvider.once
once<K>(string | symbol, (args: any[]) => void)
Dodaje funkcję jednorazowąlistener
dla zdarzenia o nazwie eventName
. Następnym razem eventName
zostanie wyzwolony odbiornik, a następnie wywołany.
server.once('connection', (stream) => {
console.log('Ah, we have our first user!');
});
Zwraca odwołanie do elementu EventEmitter
, aby można było połączyć wywołania w łańcuch.
Domyślnie odbiorniki zdarzeń są wywoływane w kolejności, w której są dodawane. Metoda emitter.prependOnceListener()
może służyć jako alternatywa, aby dodać odbiornik zdarzeń na początku tablicy odbiorników.
import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.once('foo', () => console.log('a'));
myEE.prependOnceListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
// b
// a
function once<K>(eventName: string | symbol, listener: (args: any[]) => void): IotEdgeAuthenticationProvider
Parametry
- eventName
-
string | symbol
Nazwa zdarzenia.
- listener
-
(args: any[]) => void
Funkcja wywołania zwrotnego
Zwraca
Dziedziczone zSharedAccessKeyAuthenticationProvider.once
prependListener<K>(string | symbol, (args: any[]) => void)
listener
Dodaje funkcję na początku tablicy odbiorników dla zdarzenia o nazwie eventName
. Nie są sprawdzane, czy listener
element został już dodany. Wiele wywołań przekazujących eventName
tę samą kombinację elementów i listener
spowoduje listener
dodanie i wywołanie wielu razy.
server.prependListener('connection', (stream) => {
console.log('someone connected!');
});
Zwraca odwołanie do elementu EventEmitter
, aby można było połączyć wywołania w łańcuch.
function prependListener<K>(eventName: string | symbol, listener: (args: any[]) => void): IotEdgeAuthenticationProvider
Parametry
- eventName
-
string | symbol
Nazwa zdarzenia.
- listener
-
(args: any[]) => void
Funkcja wywołania zwrotnego
Zwraca
Dziedziczone zelementu SharedAccessKeyAuthenticationProvider.prependListener
prependOnceListener<K>(string | symbol, (args: any[]) => void)
Dodaje jednorazowąlistener
funkcję zdarzenia o nazwie eventName
na początku tablicy odbiorników. Następnym razem eventName
zostanie wyzwolony, ten odbiornik zostanie usunięty, a następnie wywołany.
server.prependOnceListener('connection', (stream) => {
console.log('Ah, we have our first user!');
});
Zwraca odwołanie do elementu EventEmitter
, aby można było połączyć wywołania w łańcuch.
function prependOnceListener<K>(eventName: string | symbol, listener: (args: any[]) => void): IotEdgeAuthenticationProvider
Parametry
- eventName
-
string | symbol
Nazwa zdarzenia.
- listener
-
(args: any[]) => void
Funkcja wywołania zwrotnego
Zwraca
Dziedziczone zelementu SharedAccessKeyAuthenticationProvider.prependOnceListener
rawListeners<K>(string | symbol)
Zwraca kopię tablicy odbiorników dla zdarzenia o nazwie eventName
, w tym wszelkie otoki (takie jak utworzone przez .once()
program ).
import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.once('log', () => console.log('log once'));
// Returns a new Array with a function `onceWrapper` which has a property
// `listener` which contains the original listener bound above
const listeners = emitter.rawListeners('log');
const logFnWrapper = listeners[0];
// Logs "log once" to the console and does not unbind the `once` event
logFnWrapper.listener();
// Logs "log once" to the console and removes the listener
logFnWrapper();
emitter.on('log', () => console.log('log persistently'));
// Will return a new Array with a single function bound by `.on()` above
const newListeners = emitter.rawListeners('log');
// Logs "log persistently" twice
newListeners[0]();
emitter.emit('log');
function rawListeners<K>(eventName: string | symbol): Function[]
Parametry
- eventName
-
string | symbol
Zwraca
Function[]
Dziedziczone zSharedAccessKeyAuthenticationProvider.rawListeners
removeAllListeners(string | symbol)
Usuwa wszystkie odbiorniki lub te z określonego eventName
elementu .
Niewłaściwą praktyką jest usunięcie odbiorników dodanych w innym miejscu w kodzie, szczególnie w przypadku EventEmitter
utworzenia wystąpienia przez inny składnik lub moduł (np. gniazda lub strumienie plików).
Zwraca odwołanie do elementu EventEmitter
, aby można było połączyć wywołania w łańcuch.
function removeAllListeners(eventName?: string | symbol): IotEdgeAuthenticationProvider
Parametry
- eventName
-
string | symbol
Zwraca
Dziedziczone zsharedAccessKeyAuthenticationProvider.removeAllListeners
removeListener<K>(string | symbol, (args: any[]) => void)
Usuwa określony listener
element z tablicy odbiorników dla zdarzenia o nazwie eventName
.
const callback = (stream) => {
console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);
removeListener()
spowoduje usunięcie co najwyżej jednego wystąpienia odbiornika z tablicy odbiornika. Jeśli którykolwiek pojedynczy odbiornik został dodany wiele razy do tablicy odbiornika dla określonego eventName
elementu , removeListener()
należy wywołać wiele razy, aby usunąć każde wystąpienie.
Po emitowaniu zdarzenia wszystkie odbiorniki dołączone do niego w momencie emitowania są wywoływane w kolejności. Oznacza to, że wszystkie removeListener()
wywołania lub removeAllListeners()
po emitowaniu i przed zakończeniem wykonywania ostatniego odbiornika nie zostaną usunięte zemit()
postępu. Kolejne zdarzenia zachowują się zgodnie z oczekiwaniami.
import { EventEmitter } from 'node:events';
class MyEmitter extends EventEmitter {}
const myEmitter = new MyEmitter();
const callbackA = () => {
console.log('A');
myEmitter.removeListener('event', callbackB);
};
const callbackB = () => {
console.log('B');
};
myEmitter.on('event', callbackA);
myEmitter.on('event', callbackB);
// callbackA removes listener callbackB but it will still be called.
// Internal listener array at time of emit [callbackA, callbackB]
myEmitter.emit('event');
// Prints:
// A
// B
// callbackB is now removed.
// Internal listener array [callbackA]
myEmitter.emit('event');
// Prints:
// A
Ponieważ odbiorniki są zarządzane przy użyciu tablicy wewnętrznej, wywołanie tej funkcji spowoduje zmianę indeksów pozycji każdego odbiornika zarejestrowanego po usunięciu odbiornika. Nie będzie to miało wpływu na kolejność wywoływanych odbiorników, ale oznacza to, że wszystkie kopie tablicy odbiorników zwrócone przez emitter.listeners()
metodę będą musiały zostać ponownie odtworzone.
Jeśli pojedyncza funkcja została dodana jako procedura obsługi wiele razy dla pojedynczego zdarzenia (jak w poniższym przykładzie), removeListener()
spowoduje usunięcie ostatnio dodanego wystąpienia. W przykładzie odbiornik once('ping')
jest usuwany:
import { EventEmitter } from 'node:events';
const ee = new EventEmitter();
function pong() {
console.log('pong');
}
ee.on('ping', pong);
ee.once('ping', pong);
ee.removeListener('ping', pong);
ee.emit('ping');
ee.emit('ping');
Zwraca odwołanie do elementu EventEmitter
, aby można było połączyć wywołania w łańcuch.
function removeListener<K>(eventName: string | symbol, listener: (args: any[]) => void): IotEdgeAuthenticationProvider
Parametry
- eventName
-
string | symbol
- listener
-
(args: any[]) => void
Zwraca
Dziedziczone zelementu SharedAccessKeyAuthenticationProvider.removeListener
setMaxListeners(number)
Domyślnie EventEmitter
program wyświetli ostrzeżenie, jeśli dla określonego zdarzenia zostanie dodanych więcej niż 10
odbiorniki. Jest to przydatne ustawienie domyślne, które pomaga znaleźć przecieki pamięci. Metoda emitter.setMaxListeners()
umożliwia zmodyfikowanie limitu dla tego konkretnego EventEmitter
wystąpienia. Wartość można ustawić na Infinity
(lub 0
), aby wskazać nieograniczoną liczbę odbiorników.
Zwraca odwołanie do elementu EventEmitter
, aby można było połączyć wywołania w łańcuch.
function setMaxListeners(n: number): IotEdgeAuthenticationProvider
Parametry
- n
-
number
Zwraca
Dziedziczone zSharedAccessKeyAuthenticationProvider.setMaxListeners
setMaxListeners(number, (EventEmitter<DefaultEventMap> | EventTarget)[])
import { setMaxListeners, EventEmitter } from 'node:events';
const target = new EventTarget();
const emitter = new EventEmitter();
setMaxListeners(5, target, emitter);
static function setMaxListeners(n?: number, eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[])
Parametry
- n
-
number
Liczba nieujemna. Maksymalna liczba odbiorników na EventTarget
zdarzenie.
- eventTargets
-
(EventEmitter<DefaultEventMap> | EventTarget)[]
Dziedziczone zSharedAccessKeyAuthenticationProvider.setMaxListeners
setTokenRenewalValues(number, number)
Ta metoda umożliwia obiektowi wywołującego ustawienie nowych wartości na potrzeby odnawiania uwierzytelniania.
Ta funkcja jest wykonywana synchronicznie, ale spowoduje asynchroniczne wykonywanie akcji. Jeśli dostawca już odnawia token, na przykład — jeśli połączenie sieciowe zostało nawiązane, wywołanie tej funkcji spowoduje niemal natychmiastowe wznowienie. W zależności od protokołu może to spowodować rozłączenie i ponowne nawiązanie połączenia. Jeśli jednak odnowienia nie są obecnie wykonywane, po prostu zapiszemy nowe wartości do późniejszego użycia.
function setTokenRenewalValues(tokenValidTimeInSeconds: number, tokenRenewalMarginInSeconds: number)
Parametry
- tokenValidTimeInSeconds
-
number
Liczba sekund, dla których token ma być prawidłowy.
- tokenRenewalMarginInSeconds
-
number
Liczba sekund przed końcem okresu ważności, w którym SharedAccessKeyAuthenticationProvider
element powinien odnowić token.
Dziedziczone zsharedAccessKeyAuthenticationProvider.setTokenRenewalValues
stop()
Zatrzymuje czasomierz używany do odnawiania tokenu SAS.
function stop()
Dziedziczone zsharedAccessKeyAuthenticationProvider.stop
[captureRejectionSymbol]<K>(Error, string | symbol, AnyRest)
function [captureRejectionSymbol]<K>(error: Error, event: string | symbol, args: AnyRest)
Parametry
- error
-
Error
- event
-
string | symbol
- args
-
AnyRest
Dziedziczone zSharedAccessKeyAuthenticationProvider.[ captureRejectionSymbol]