Client class
IoT Hub client d’appareil utilisé pour connecter un appareil à un hub Azure IoT.
Les utilisateurs du KIT de développement logiciel (SDK) doivent appeler l’une des méthodes de fabrique, à partir deConnectionString ou deSharedAccessSignature pour créer un client d’appareil IoT Hub.
- Extends
-
InternalClient
Constructeurs
Client(Device |
Propriétés héritées
capture |
Valeur : booléen Modifiez l’option par défaut |
capture |
Valeur: Découvrez comment écrire un personnalisé |
default |
Par défaut, un maximum d’écouteurs Soyez prudent lorsque vous définissez le Il ne s’agit pas d’une limite stricte. Le
L’indicateur L’avertissement émis peut être inspecté avec |
error |
Ce symbole doit être utilisé pour installer un écouteur uniquement pour les événements de surveillance L’installation d’un écouteur à l’aide de ce symbole ne modifie pas le comportement une fois qu’un |
Méthodes
close() | |
close(Callback<Disconnected>) | Ferme la connexion de transport et détruit les ressources clientes. Remarque : Après avoir appelé cette méthode, l’objet Client ne peut pas être réutilisé. |
from |
Crée un client d’appareil IoT Hub à partir de la méthode d’authentification donnée et à l’aide du type de transport donné. |
from |
Crée un client d’appareil IoT Hub à partir du chaîne de connexion donné à l’aide du type de transport donné. |
from |
Crée un client d’appareil IoT Hub à partir de la signature d’accès partagé donnée à l’aide du type de transport donné. |
get |
|
get |
obtient |
notify |
|
notify |
La |
on |
Inscrit un rappel pour une méthode nommée |
set |
|
set |
|
upload |
|
upload |
La |
Méthodes héritées
abandon(Message) | |
abandon(Message, Callback<Message |
|
add |
Écoute une fois l’événement L’écoute de l’événement sur les Cette API permet d’utiliser Retourne un jetable afin qu’il puisse être désinscrit plus facilement.
|
add |
Alias pour |
complete(Message) | |
complete(Message, Callback<Message |
|
emit<K>(string | symbol, Any |
Appelle de manière synchrone chacun des écouteurs inscrits pour l’événement nommé Retourne
|
event |
Retourne un tableau répertoriant les événements pour lesquels l’émetteur dispose d’écouteurs inscrits. Les valeurs du tableau sont des chaînes ou
|
get |
Retourne une copie du tableau d’écouteurs pour l’événement nommé Pour Pour
|
get |
Retourne la valeur actuelle de l’écouteur maximal pour le |
get |
Retourne la quantité maximale d’écouteurs actuellement définie. Pour Pour
|
get |
|
get |
|
listener |
Méthode de classe qui retourne le nombre d’écouteurs pour le donné
|
listener |
Retourne le nombre d’écouteurs qui écoutent l’événement nommé |
listeners<K>(string | symbol) | Retourne une copie du tableau d’écouteurs pour l’événement nommé
|
off<K>(string | symbol, (args: any[]) => void) | Alias pour |
on(Event |
Retourne un Un
|
on<K>(string | symbol, (args: any[]) => void) | Ajoute la
Retourne une référence à , Par défaut, les écouteurs d’événements sont appelés dans l’ordre dans lequel ils sont ajoutés. La
|
once(Event |
Crée un Cette méthode est intentionnellement générique et fonctionne avec l’interface EventTarget de plateforme web, qui n’a pas de sémantique d’événement spéciale
La gestion spéciale de l’événement
Un
|
once(Event |
|
once<K>(string | symbol, (args: any[]) => void) | Ajoute une fonction à usage unique
Retourne une référence à , Par défaut, les écouteurs d’événements sont appelés dans l’ordre dans lequel ils sont ajoutés. La
|
open() | |
open(Callback<Connected>) | |
prepend |
Ajoute la
Retourne une référence à , |
prepend |
Ajoute une fonction à usage unique
Retourne une référence à , |
raw |
Retourne une copie du tableau d’écouteurs pour l’événement nommé
|
reject(Message) | |
reject(Message, Callback<Message |
|
remove |
Supprime tous les écouteurs ou ceux du spécifié Il est mal pratique de supprimer les écouteurs ajoutés ailleurs dans le code, en particulier lorsque le Retourne une référence à , |
remove |
Supprime le spécifié
Une fois qu’un événement est émis, tous les écouteurs qui lui sont attachés au moment de l’émission sont appelés dans l’ordre. Cela implique que les
Étant donné que les écouteurs sont gérés à l’aide d’un tableau interne, l’appel de cela modifie les index de position de tout écouteur inscrit après la suppression de l’écouteur. Cela n’aura pas d’impact sur l’ordre dans lequel les écouteurs sont appelés, mais cela signifie que toutes les copies du tableau d’écouteurs retournées par la Lorsqu’une fonction unique a été ajoutée en tant que gestionnaire plusieurs fois pour un seul événement (comme dans l’exemple ci-dessous),
Retourne une référence à , |
send |
|
send |
|
send |
|
send |
|
set |
Par défaut Retourne une référence à , |
set |
|
set |
Définit la stratégie de nouvelle tentative utilisée par le client sur toutes les opérations. La valeur par défaut est ExponentielBackoffWithJitter. |
set |
|
set |
|
update |
|
[capture |
Détails du constructeur
Client(DeviceTransport, string, BlobUploadClient, FileUploadInterface)
new Client(transport: DeviceTransport, connStr?: string, blobUploadClient?: BlobUploadClient, fileUploadApi?: FileUploadInterface)
Paramètres
- transport
- DeviceTransport
Objet qui implémente l’interface attendue d’un objet de transport, par exemple, Http.
- connStr
-
string
Un chaîne de connexion (facultatif : lorsqu’il n’est pas fourni, updateSharedAccessSignature doit être appelé pour définir directement le jeton SharedAccessSignature).
- blobUploadClient
-
BlobUploadClient
Objet capable de charger un flux dans un objet blob.
- fileUploadApi
-
FileUploadInterface
Objet utilisé pour communiquer avec IoT Hub pour les actions liées au stockage Blob.
Détails de la propriété héritée
captureRejections
Valeur : booléen
Modifiez l’option par défaut captureRejections
sur tous les nouveaux EventEmitter
objets.
static captureRejections: boolean
Valeur de propriété
boolean
Hérité de InternalClient.captureRejections
captureRejectionSymbol
Valeur: Symbol.for('nodejs.rejection')
Découvrez comment écrire un personnalisé rejection handler
.
static captureRejectionSymbol: typeof captureRejectionSymbol
Valeur de propriété
typeof captureRejectionSymbol
Hérité de InternalClient.captureRejectionSymbol
defaultMaxListeners
Par défaut, un maximum d’écouteurs 10
peuvent être inscrits pour n’importe quel événement unique. Cette limite peut être modifiée pour des instances individuelles EventEmitter
à l’aide de la emitter.setMaxListeners(n)
méthode . Pour modifier la valeur par défaut pour toutes lesEventEmitter
instances, la events.defaultMaxListeners
propriété peut être utilisée. Si cette valeur n’est pas un nombre positif, un RangeError
est levée.
Soyez prudent lorsque vous définissez le events.defaultMaxListeners
, car la modification affecte toutes lesEventEmitter
instances, y compris celles créées avant la modification. Toutefois, l’appel emitter.setMaxListeners(n)
est toujours prioritaire sur events.defaultMaxListeners
.
Il ne s’agit pas d’une limite stricte. Le EventEmitter
instance permet d’ajouter d’autres écouteurs, mais génère un avertissement de trace à stderr indiquant qu’une « fuite de mémoire EventEmitter » a été détectée. Pour n’importe quel seul EventEmitter
, les emitter.getMaxListeners()
méthodes et emitter.setMaxListeners()
peuvent être utilisées pour éviter temporairement cet avertissement :
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));
});
L’indicateur --trace-warnings
de ligne de commande peut être utilisé pour afficher la trace de pile pour de tels avertissements.
L’avertissement émis peut être inspecté avec process.on('warning')
et aura les propriétés , type
et supplémentairesemitter
, faisant count
référence à l’émetteur d’événements instance, au nom de l’événement et au nombre d’écouteurs attachés, respectivement.
Sa name
propriété est définie sur 'MaxListenersExceededWarning'
.
static defaultMaxListeners: number
Valeur de propriété
number
Hérité de InternalClient.defaultMaxListeners
errorMonitor
Ce symbole doit être utilisé pour installer un écouteur uniquement pour les événements de surveillance 'error'
. Les écouteurs installés à l’aide de ce symbole sont appelés avant l’appel des écouteurs standard 'error'
.
L’installation d’un écouteur à l’aide de ce symbole ne modifie pas le comportement une fois qu’un 'error'
événement est émis. Par conséquent, le processus se bloque toujours si aucun écouteur standard 'error'
n’est installé.
static errorMonitor: typeof errorMonitor
Valeur de propriété
typeof errorMonitor
Hérité de InternalClient.errorMonitor
Détails de la méthode
close()
function close(): Promise<Disconnected>
Retours
Promise<Disconnected>
close(Callback<Disconnected>)
Ferme la connexion de transport et détruit les ressources clientes.
Remarque : Après avoir appelé cette méthode, l’objet Client ne peut pas être réutilisé.
function close(closeCallback?: Callback<Disconnected>)
Paramètres
- closeCallback
-
Callback<Disconnected>
Fonction facultative à appeler une fois le transport déconnecté et le client fermé.
fromAuthenticationProvider(AuthenticationProvider, any)
Crée un client d’appareil IoT Hub à partir de la méthode d’authentification donnée et à l’aide du type de transport donné.
static function fromAuthenticationProvider(authenticationProvider: AuthenticationProvider, transportCtor: any): Client
Paramètres
- authenticationProvider
-
AuthenticationProvider
Objet utilisé pour obtenir les paramètres d’authentification pour le hub IoT.
- transportCtor
-
any
Protocole de transport utilisé pour se connecter à IoT Hub.
Retours
fromConnectionString(string, any)
Crée un client d’appareil IoT Hub à partir du chaîne de connexion donné à l’aide du type de transport donné.
static function fromConnectionString(connStr: string, transportCtor: any): Client
Paramètres
- connStr
-
string
Une chaîne de connexion qui encapsule les autorisations de « connexion d’appareil » sur un hub IoT.
- transportCtor
-
any
Constructeur de transport.
Retours
fromSharedAccessSignature(string, any)
Crée un client d’appareil IoT Hub à partir de la signature d’accès partagé donnée à l’aide du type de transport donné.
static function fromSharedAccessSignature(sharedAccessSignature: string, transportCtor: any): Client
Paramètres
- sharedAccessSignature
-
string
Signature d’accès partagé qui encapsule les autorisations de « connexion d’appareil » sur un hub IoT.
- transportCtor
-
any
Retours
getBlobSharedAccessSignature(string)
function getBlobSharedAccessSignature(blobName: string): Promise<UploadParams>
Paramètres
- blobName
-
string
Retours
Promise<UploadParams>
getBlobSharedAccessSignature(string, Callback<UploadParams>)
obtient getBlobSharedAccessSignature
le jeton SAP du compte de stockage lié à partir de IoT Hub
function getBlobSharedAccessSignature(blobName: string, callback?: Callback<UploadParams>)
Paramètres
- blobName
-
string
Nom à utiliser pour l’objet blob qui sera créé avec le contenu du flux.
- callback
-
Callback<UploadParams>
Rappel facultatif à appeler lorsque le chargement est terminé.
notifyBlobUploadStatus(string, boolean, number, string)
function notifyBlobUploadStatus(correlationId: string, isSuccess: boolean, statusCode: number, statusDescription: string): Promise<void>
Paramètres
- correlationId
-
string
- isSuccess
-
boolean
- statusCode
-
number
- statusDescription
-
string
Retours
Promise<void>
notifyBlobUploadStatus(string, boolean, number, string, ErrorCallback)
La notifyBlobUploadStatus
méthode envoie IoT Hub le résultat d’un chargement d’objets blob.
function notifyBlobUploadStatus(correlationId: string, isSuccess: boolean, statusCode: number, statusDescription: string, callback?: ErrorCallback)
Paramètres
- correlationId
-
string
ID permettant de corrélater un status de chargement à un objet blob spécifique. Généré pendant l’appel à getBlobSharedAccessSignature
.
- isSuccess
-
boolean
La réussite ou l’échec status à partir du résultat de l’opération d’objet blob de stockage.
- statusCode
-
number
Le code HTTP status associé au résultat de l’objet blob de stockage.
- statusDescription
-
string
Description du code status HTTP.
- callback
-
ErrorCallback
Rappel facultatif à appeler lorsque le chargement est terminé.
onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void)
Inscrit un rappel pour une méthode nommée methodName
.
function onDeviceMethod(methodName: string, callback: (request: DeviceMethodRequest, response: DeviceMethodResponse) => void)
Paramètres
- methodName
-
string
Nom de la méthode qui sera gérée par le rappel
- callback
-
(request: DeviceMethodRequest, response: DeviceMethodResponse) => void
Fonction qui doit être appelée chaque fois qu’une demande de méthode pour la méthode appelée methodName
est reçue.
setOptions(DeviceClientOptions)
function setOptions(options: DeviceClientOptions): Promise<TransportConfigured>
Paramètres
- options
- DeviceClientOptions
Retours
Promise<TransportConfigured>
setOptions(DeviceClientOptions, Callback<TransportConfigured>)
function setOptions(options: DeviceClientOptions, done: Callback<TransportConfigured>)
Paramètres
- options
- DeviceClientOptions
- done
-
Callback<TransportConfigured>
uploadToBlob(string, Stream, number)
function uploadToBlob(blobName: string, stream: Stream, streamLength: number): Promise<void>
Paramètres
- blobName
-
string
- stream
-
Stream
- streamLength
-
number
Retours
Promise<void>
uploadToBlob(string, Stream, number, ErrorCallback)
La uploadToBlob
méthode charge un flux dans un objet blob.
function uploadToBlob(blobName: string, stream: Stream, streamLength: number, callback: ErrorCallback)
Paramètres
- blobName
-
string
Nom à utiliser pour l’objet blob qui sera créé avec le contenu du flux.
- stream
-
Stream
Les données dans qui doivent être chargées dans l’objet blob.
- streamLength
-
number
Taille des données dans qui doivent être chargées dans l’objet blob.
- callback
-
ErrorCallback
Détails de la méthode héritée
abandon(Message)
function abandon(message: Message): Promise<MessageAbandoned>
Paramètres
- message
- Message
Retours
Promise<MessageAbandoned>
Hérité de InternalClient.abandon
abandon(Message, Callback<MessageAbandoned>)
function abandon(message: Message, abandonCallback: Callback<MessageAbandoned>)
Paramètres
- message
- Message
- abandonCallback
-
Callback<MessageAbandoned>
Hérité de InternalClient.abandon
addAbortListener(AbortSignal, (event: Event) => void)
Écoute une fois l’événement abort
sur le fourni signal
.
L’écoute de l’événement sur les abort
signaux d’abandon est dangereuse et peut entraîner des fuites de ressources, car un autre tiers avec le signal peut appeler e.stopImmediatePropagation()
. Malheureusement, Node.js ne pouvez pas changer cela, car cela violerait la norme web. En outre, l’API d’origine permet d’oublier facilement de supprimer les écouteurs.
Cette API permet d’utiliser AbortSignal
des s en toute sécurité dans les API Node.js en résolvant ces deux problèmes en écoutant l’événement, ce qui stopImmediatePropagation
n’empêche pas l’écouteur de s’exécuter.
Retourne un jetable afin qu’il puisse être désinscrit plus facilement.
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
Paramètres
- signal
-
AbortSignal
- resource
-
(event: Event) => void
Retours
Disposable
Jetable qui supprime l’écouteur abort
.
Hérité de InternalClient.addAbortListener
addListener<K>(string | symbol, (args: any[]) => void)
Alias pour emitter.on(eventName, listener)
.
function addListener<K>(eventName: string | symbol, listener: (args: any[]) => void): Client
Paramètres
- eventName
-
string | symbol
- listener
-
(args: any[]) => void
Retours
Hérité de InternalClient.addListener
complete(Message)
function complete(message: Message): Promise<MessageCompleted>
Paramètres
- message
- Message
Retours
Promise<MessageCompleted>
Hérité de InternalClient.complete
complete(Message, Callback<MessageCompleted>)
function complete(message: Message, completeCallback: Callback<MessageCompleted>)
Paramètres
- message
- Message
- completeCallback
-
Callback<MessageCompleted>
Hérité de InternalClient.complete
emit<K>(string | symbol, AnyRest)
Appelle de manière synchrone chacun des écouteurs inscrits pour l’événement nommé eventName
, dans l’ordre dans lequel ils ont été inscrits, en passant les arguments fournis à chacun d’eux.
Retourne true
si l’événement avait des écouteurs, false
sinon.
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
Paramètres
- eventName
-
string | symbol
- args
-
AnyRest
Retours
boolean
Hérité de InternalClient.emit
eventNames()
Retourne un tableau répertoriant les événements pour lesquels l’émetteur dispose d’écouteurs inscrits. Les valeurs du tableau sont des chaînes ou Symbol
des 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)[]
Retours
(string | symbol)[]
Hérité de InternalClient.eventNames
getEventListeners(EventEmitter<DefaultEventMap> | EventTarget, string | symbol)
Retourne une copie du tableau d’écouteurs pour l’événement nommé eventName
.
Pour EventEmitter
s, cela se comporte exactement comme appeler .listeners
sur l’émetteur.
Pour EventTarget
s, il s’agit de la seule façon d’obtenir les écouteurs d’événements pour la cible d’événement. Cela est utile à des fins de débogage et de diagnostic.
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[]
Paramètres
- emitter
-
EventEmitter<DefaultEventMap> | EventTarget
- name
-
string | symbol
Retours
Function[]
Hérité de InternalClient.getEventListeners
getMaxListeners()
Retourne la valeur actuelle de l’écouteur maximal pour le EventEmitter
qui est défini par ou par emitter.setMaxListeners(n)
défaut sur defaultMaxListeners.
function getMaxListeners(): number
Retours
number
Hérité de InternalClient.getMaxListeners
getMaxListeners(EventEmitter<DefaultEventMap> | EventTarget)
Retourne la quantité maximale d’écouteurs actuellement définie.
Pour EventEmitter
s, cela se comporte exactement comme appeler .getMaxListeners
sur l’émetteur.
Pour EventTarget
s, il s’agit de la seule façon d’obtenir le nombre maximal d’écouteurs d’événements pour la cible d’événement. Si le nombre de gestionnaires d’événements sur un seul EventTarget dépasse le nombre maximal défini, eventTarget affiche un avertissement.
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
Paramètres
- emitter
-
EventEmitter<DefaultEventMap> | EventTarget
Retours
number
Hérité de InternalClient.getMaxListeners
getTwin()
getTwin(Callback<Twin>)
function getTwin(done: Callback<Twin>)
Paramètres
- done
-
Callback<Twin>
Hérité de InternalClient.getTwin
listenerCount(EventEmitter<DefaultEventMap>, string | symbol)
Avertissement
Cette API est à présent déconseillée.
Since v3.2.0 - Use listenerCount
instead.
Méthode de classe qui retourne le nombre d’écouteurs pour le donné eventName
inscrit sur le donné 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
Paramètres
- emitter
-
EventEmitter<DefaultEventMap>
Émetteur à interroger
- eventName
-
string | symbol
Nom de l’événement
Retours
number
Hérité de InternalClient.listenerCount
listenerCount<K>(string | symbol, Function)
Retourne le nombre d’écouteurs qui écoutent l’événement nommé eventName
.
Si listener
est fourni, il retourne le nombre de fois où l’écouteur se trouve dans la liste des écouteurs de l’événement.
function listenerCount<K>(eventName: string | symbol, listener?: Function): number
Paramètres
- eventName
-
string | symbol
Nom de l’événement écouté
- listener
-
Function
Fonction de gestionnaire d’événements
Retours
number
Hérité de InternalClient.listenerCount
listeners<K>(string | symbol)
Retourne une copie du tableau d’écouteurs pour l’événement nommé 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[]
Paramètres
- eventName
-
string | symbol
Retours
Function[]
Hérité de InternalClient.listeners
off<K>(string | symbol, (args: any[]) => void)
Alias pour emitter.removeListener()
.
function off<K>(eventName: string | symbol, listener: (args: any[]) => void): Client
Paramètres
- eventName
-
string | symbol
- listener
-
(args: any[]) => void
Retours
Hérité de InternalClient.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
Retourne un AsyncIterator
qui itère les eventName
événements. Il se lève si le EventEmitter
émet 'error'
. Il supprime tous les écouteurs lors de la sortie de la boucle. Le value
retourné par chaque itération est un tableau composé des arguments d’événement émis.
Un AbortSignal
peut être utilisé pour annuler l’attente d’événements :
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>
Paramètres
- emitter
-
EventEmitter<DefaultEventMap>
- eventName
-
string
Nom de l’événement écouté
- options
-
StaticEventEmitterOptions
Retours
AsyncIterableIterator<any>
AsyncIterator
qui itère les eventName
événements émis par leemitter
Hérité de InternalClient.on
on<K>(string | symbol, (args: any[]) => void)
Ajoute la listener
fonction à la fin du tableau d’écouteurs pour l’événement nommé eventName
. Aucune vérification n’est effectuée pour voir si le listener
a déjà été ajouté. Plusieurs appels passant la même combinaison de eventName
et listener
entraînent l’ajout et l’appel listener
de plusieurs fois.
server.on('connection', (stream) => {
console.log('someone connected!');
});
Retourne une référence à , EventEmitter
afin que les appels puissent être chaînés.
Par défaut, les écouteurs d’événements sont appelés dans l’ordre dans lequel ils sont ajoutés. La emitter.prependListener()
méthode peut être utilisée comme alternative pour ajouter l’écouteur d’événements au début du tableau d’écouteurs.
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): Client
Paramètres
- eventName
-
string | symbol
Nom de l’événement.
- listener
-
(args: any[]) => void
Fonction de rappel
Retours
Hérité de InternalClient.on
once(EventEmitter<DefaultEventMap>, string | symbol, StaticEventEmitterOptions)
Crée un Promise
qui est rempli lorsque le émet l’événement EventEmitter
donné ou qui est rejeté si le EventEmitter
émet 'error'
en attente.
le Promise
se résout avec un tableau de tous les arguments émis dans l’événement donné.
Cette méthode est intentionnellement générique et fonctionne avec l’interface EventTarget de plateforme web, qui n’a pas de sémantique d’événement spéciale'error'
et n’écoute pas l’événement '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 gestion spéciale de l’événement 'error'
n’est utilisée que lorsqu’elle events.once()
est utilisée pour attendre un autre événement. Si events.once()
est utilisé pour attendre l’événement 'error'
lui-même, il est traité comme tout autre type d’événement sans traitement spécial :
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
peut être utilisé pour annuler l’attente de l’événement :
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[]>
Paramètres
- emitter
-
EventEmitter<DefaultEventMap>
- eventName
-
string | symbol
- options
-
StaticEventEmitterOptions
Retours
Promise<any[]>
Hérité de InternalClient.once
once(EventTarget, string, StaticEventEmitterOptions)
static function once(emitter: EventTarget, eventName: string, options?: StaticEventEmitterOptions): Promise<any[]>
Paramètres
- emitter
-
EventTarget
- eventName
-
string
- options
-
StaticEventEmitterOptions
Retours
Promise<any[]>
Hérité de InternalClient.once
once<K>(string | symbol, (args: any[]) => void)
Ajoute une fonction à usage uniquelistener
pour l’événement nommé eventName
. La prochaine fois eventName
qu’est déclenché, cet écouteur est supprimé, puis appelé.
server.once('connection', (stream) => {
console.log('Ah, we have our first user!');
});
Retourne une référence à , EventEmitter
afin que les appels puissent être chaînés.
Par défaut, les écouteurs d’événements sont appelés dans l’ordre dans lequel ils sont ajoutés. La emitter.prependOnceListener()
méthode peut être utilisée comme alternative pour ajouter l’écouteur d’événements au début du tableau d’écouteurs.
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): Client
Paramètres
- eventName
-
string | symbol
Nom de l’événement.
- listener
-
(args: any[]) => void
Fonction de rappel
Retours
Hérité de InternalClient.once
open()
function open(): Promise<Connected>
Retours
Promise<Connected>
Hérité de InternalClient.open
open(Callback<Connected>)
function open(openCallback: Callback<Connected>)
Paramètres
- openCallback
-
Callback<Connected>
Hérité de InternalClient.open
prependListener<K>(string | symbol, (args: any[]) => void)
Ajoute la listener
fonction au début du tableau d’écouteurs pour l’événement nommé eventName
. Aucune vérification n’est effectuée pour voir si le listener
a déjà été ajouté. Plusieurs appels passant la même combinaison de eventName
et listener
entraînent l’ajout et l’appel listener
de plusieurs fois.
server.prependListener('connection', (stream) => {
console.log('someone connected!');
});
Retourne une référence à , EventEmitter
afin que les appels puissent être chaînés.
function prependListener<K>(eventName: string | symbol, listener: (args: any[]) => void): Client
Paramètres
- eventName
-
string | symbol
Nom de l’événement.
- listener
-
(args: any[]) => void
Fonction de rappel
Retours
Hérité de InternalClient.prependListener
prependOnceListener<K>(string | symbol, (args: any[]) => void)
Ajoute une fonction à usage uniquelistener
pour l’événement nommé eventName
au début du tableau d’écouteurs. La prochaine fois eventName
qu’est déclenché, cet écouteur est supprimé, puis appelé.
server.prependOnceListener('connection', (stream) => {
console.log('Ah, we have our first user!');
});
Retourne une référence à , EventEmitter
afin que les appels puissent être chaînés.
function prependOnceListener<K>(eventName: string | symbol, listener: (args: any[]) => void): Client
Paramètres
- eventName
-
string | symbol
Nom de l’événement.
- listener
-
(args: any[]) => void
Fonction de rappel
Retours
Hérité de InternalClient.prependOnceListener
rawListeners<K>(string | symbol)
Retourne une copie du tableau d’écouteurs pour l’événement nommé eventName
, y compris tous les wrappers (tels que ceux créés par .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[]
Paramètres
- eventName
-
string | symbol
Retours
Function[]
Hérité de InternalClient.rawListeners
reject(Message)
function reject(message: Message): Promise<MessageRejected>
Paramètres
- message
- Message
Retours
Promise<MessageRejected>
Hérité de InternalClient.reject
reject(Message, Callback<MessageRejected>)
function reject(message: Message, rejectCallback: Callback<MessageRejected>)
Paramètres
- message
- Message
- rejectCallback
-
Callback<MessageRejected>
Hérité de InternalClient.reject
removeAllListeners(string | symbol)
Supprime tous les écouteurs ou ceux du spécifié eventName
.
Il est mal pratique de supprimer les écouteurs ajoutés ailleurs dans le code, en particulier lorsque le EventEmitter
instance a été créé par un autre composant ou module (par exemple, des sockets ou des flux de fichiers).
Retourne une référence à , EventEmitter
afin que les appels puissent être chaînés.
function removeAllListeners(eventName?: string | symbol): Client
Paramètres
- eventName
-
string | symbol
Retours
Hérité de InternalClient.removeAllListeners
removeListener<K>(string | symbol, (args: any[]) => void)
Supprime le spécifié listener
du tableau d’écouteurs pour l’événement nommé eventName
.
const callback = (stream) => {
console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);
removeListener()
supprime, au maximum, une instance d’un écouteur du tableau d’écouteurs. Si un écouteur unique a été ajouté plusieurs fois au tableau d’écouteurs pour le spécifié eventName
, removeListener()
il doit être appelé plusieurs fois pour supprimer chaque instance.
Une fois qu’un événement est émis, tous les écouteurs qui lui sont attachés au moment de l’émission sont appelés dans l’ordre. Cela implique que les removeListener()
appels ou removeAllListeners()
après l’émission et avant la fin de l’exécution du dernier écouteur ne les suppriment pas deemit()
en cours. Les événements suivants se comportent comme prévu.
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
Étant donné que les écouteurs sont gérés à l’aide d’un tableau interne, l’appel de cela modifie les index de position de tout écouteur inscrit après la suppression de l’écouteur. Cela n’aura pas d’impact sur l’ordre dans lequel les écouteurs sont appelés, mais cela signifie que toutes les copies du tableau d’écouteurs retournées par la emitter.listeners()
méthode devront être recréées.
Lorsqu’une fonction unique a été ajoutée en tant que gestionnaire plusieurs fois pour un seul événement (comme dans l’exemple ci-dessous), removeListener()
supprime le instance le plus récemment ajouté. Dans l’exemple, l’écouteur once('ping')
est supprimé :
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');
Retourne une référence à , EventEmitter
afin que les appels puissent être chaînés.
function removeListener<K>(eventName: string | symbol, listener: (args: any[]) => void): Client
Paramètres
- eventName
-
string | symbol
- listener
-
(args: any[]) => void
Retours
Hérité de InternalClient.removeListener
sendEvent(Message)
function sendEvent(message: Message): Promise<MessageEnqueued>
Paramètres
- message
- Message
Retours
Promise<MessageEnqueued>
Hérité de InternalClient.sendEvent
sendEvent(Message, Callback<MessageEnqueued>)
function sendEvent(message: Message, sendEventCallback: Callback<MessageEnqueued>)
Paramètres
- message
- Message
- sendEventCallback
-
Callback<MessageEnqueued>
Hérité de InternalClient.sendEvent
sendEventBatch(Message[])
function sendEventBatch(messages: Message[]): Promise<MessageEnqueued>
Paramètres
- messages
-
Message[]
Retours
Promise<MessageEnqueued>
Hérité de InternalClient.sendEventBatch
sendEventBatch(Message[], Callback<MessageEnqueued>)
function sendEventBatch(messages: Message[], sendEventBatchCallback: Callback<MessageEnqueued>)
Paramètres
- messages
-
Message[]
- sendEventBatchCallback
-
Callback<MessageEnqueued>
Hérité de InternalClient.sendEventBatch
setMaxListeners(number)
Par défaut EventEmitter
, s affiche un avertissement si plusieurs 10
écouteurs sont ajoutés pour un événement particulier. Il s’agit d’une valeur par défaut utile qui permet de rechercher les fuites de mémoire. La emitter.setMaxListeners()
méthode permet de modifier la limite pour ce instance spécifique EventEmitter
. La valeur peut être définie sur Infinity
(ou 0
) pour indiquer un nombre illimité d’écouteurs.
Retourne une référence à , EventEmitter
afin que les appels puissent être chaînés.
function setMaxListeners(n: number): Client
Paramètres
- n
-
number
Retours
Hérité de InternalClient.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)[])
Paramètres
- n
-
number
Nombre non négatif. Nombre maximal d’écouteurs par EventTarget
événement.
- eventTargets
-
(EventEmitter<DefaultEventMap> | EventTarget)[]
Hérité de InternalClient.setMaxListeners
setRetryPolicy(RetryPolicy)
Définit la stratégie de nouvelle tentative utilisée par le client sur toutes les opérations. La valeur par défaut est ExponentielBackoffWithJitter.
function setRetryPolicy(policy: RetryPolicy)
Paramètres
- policy
-
RetryPolicy
{RetryPolicy} Stratégie de nouvelle tentative qui doit être utilisée pour toutes les opérations futures.
Hérité de InternalClient.setRetryPolicy
setTransportOptions(any)
function setTransportOptions(options: any): Promise<TransportConfigured>
Paramètres
- options
-
any
Retours
Promise<TransportConfigured>
Hérité de InternalClient.setTransportOptions
setTransportOptions(any, Callback<TransportConfigured>)
function setTransportOptions(options: any, done: Callback<TransportConfigured>)
Paramètres
- options
-
any
- done
-
Callback<TransportConfigured>
Hérité de InternalClient.setTransportOptions
updateSharedAccessSignature(string, Callback<SharedAccessSignatureUpdated>)
function updateSharedAccessSignature(sharedAccessSignature: string, updateSasCallback?: Callback<SharedAccessSignatureUpdated>)
Paramètres
- sharedAccessSignature
-
string
- updateSasCallback
-
Callback<SharedAccessSignatureUpdated>
Hérité de InternalClient.updateSharedAccessSignature
[captureRejectionSymbol]<K>(Error, string | symbol, AnyRest)
function [captureRejectionSymbol]<K>(error: Error, event: string | symbol, args: AnyRest)
Paramètres
- error
-
Error
- event
-
string | symbol
- args
-
AnyRest
Hérité de InternalClient.__@captureRejectionSymbol@138