@azure/core-amqp package

Classes

CbsClient	Décrit le client EventHub/ServiceBus Cbs qui communique avec le point de terminaison $cbs via une connexion AMQP.
MessagingError	Décrit la classe de base pour l’erreur de messagerie.
RequestResponseLink	Décrit un lien demande(expéditeur)-réponse(récepteur) amqp créé via une session amqp.

Interfaces

AcquireLockProperties	Décrit les propriétés qui doivent être fournies lors de l’acquisition d’un verrou.
AmqpAnnotatedMessage	Décrit l’AmqpAnnotatedMessage, qui fait partie de la propriété ServiceBusReceivedMessage(as amqpAnnotatedMessage ).
AmqpMessageHeader	Décrit l’ensemble défini de propriétés d’en-tête standard du message.
AmqpMessageProperties	Décrit l’ensemble défini de propriétés standard du message.
CancellableAsyncLock	CancellableAsyncLock fournit un mécanisme pour forcer les tâches utilisant la même « clé » à être exécutées en série. Les tâches en attente peuvent être annulées manuellement via un abandonSignal ou automatiquement annulées en accédant à une valeur de délai d’expiration fournie.
CbsResponse	Décrit la réponse CBS.
ConnectionConfig	Décrit l’objet de configuration de connexion créé après l’analyse d’une chaîne de connexion EventHub ou ServiceBus.
ConnectionConfigOptions	Décrit les options qui peuvent être fournies lors de la création d’une configuration de connexion.
ConnectionContextBase	Fournit des informations contextuelles telles que la connexion amqp sous-jacente, la session cbs, tokenProvider, la configuration de connexion, le transformateur de données, etc.
ConnectionProperties	Définit les propriétés qui doivent être définies lors de l’établissement de la connexion AMQP.
CreateConnectionContextBaseParameters	Décrit les paramètres qui peuvent être fournis pour créer le contexte de connexion de base.
NetworkSystemError	Décrit les champs d’un Node.js SystemError. Omet les champs qui ne sont pas liés aux appels réseau (par exemple, les appels de système de fichiers). Voir https://nodejs.org/dist/latest-v12.x/docs/api/errors.html#errors_class_systemerror
RetryConfig	Décrit les paramètres qui doivent être configurés pour l’opération de nouvelle tentative.
RetryOptions	Options de stratégie de nouvelle tentative qui déterminent le mode, le nombre de nouvelles tentatives, l’intervalle de nouvelle tentative, etc.
SendRequestOptions	Décrit les options qui peuvent être spécifiées lors de l’envoi d’une demande.
WebSocketOptions	Options permettant de configurer le canal de la connexion AMQP sur des sockets web.

Alias de type

ParsedOutput

Définit un objet avec des propriétés possibles définies dans T.

Énumérations

ConditionErrorNameMapper	Mappe les conditions d’erreur amqp aux noms d’erreur.
ErrorNameConditionMapper	Mappe les noms d’erreur aux conditions d’erreur amqp.
RetryMode	Décrit le type de mode nouvelle tentative
RetryOperationType	Décrit le type d’opération de nouvelle tentative.
SystemErrorConditionMapper	Mappe certaines erreurs SystemErrors aux conditions d’erreur amqp
TokenType	Décrit le type de jetons pris en charge.

Fonctions

delay<T>(number, AbortSignalLike, string, T)	Wrapper pour setTimeout qui résout une promesse après t millisecondes.
isMessagingError(MessagingError | Error)	Détermine si une erreur est un message d’erreur MessagingError.
isSystemError(unknown)	Vérifie si l’erreur fournie est une node.js SystemError.
parseConnectionString<T>(string)	Analyse la chaîne de connexion et retourne un objet de type T. Les chaînes de connexion ont la syntaxe suivante : ConnectionString ::= Part { ";" Part } [ ";" ] [ WhiteSpace ] Part ::= [ PartLiteral [ « = » PartLiteral ] PartLiteral ::= [ WhiteSpace ] Littéral [ WhiteSpace ] Littéral ::= ? toute séquence de caractères à l’exception de ; ou = ou Espace blanc ? Espace blanc ::= ? tous les espaces blancs, y compris \r et \n ?
retry<T>(RetryConfig<T>)	Chaque opération est tentée au moins une fois. D’autres tentatives sont effectuées si la tentative précédente a échoué avec une erreur pouvant être réessayée. Le nombre de tentatives supplémentaires est régi par la maxRetries propriété fournie sur l’argument RetryConfig . Si mode l’option a la Fixedvaleur , les nouvelles tentatives sont effectuées sur l’opération donnée pour un nombre spécifié de fois, avec un délai fixe entre chaque nouvelle tentative. Si mode l’option a la Exponentialvaleur , le délai entre les nouvelles tentatives est ajusté pour augmenter de façon exponentielle à chaque tentative à l’aide du facteur d’arrêt de la puissance 2.
translate(unknown)	Traduit l’erreur AMQP reçue au niveau de la couche de protocole ou d’une erreur SystemError en messageError. Toutes les autres erreurs sont retournées sans avoir été affectées.

Informations relatives à la fonction

delay<T>(number, AbortSignalLike, string, T)

Wrapper pour setTimeout qui résout une promesse après t millisecondes.

function delay<T>(delayInMs: number, abortSignal?: AbortSignalLike, abortErrorMsg?: string, value?: T): Promise<T | void>

Paramètres

delayInMs

number

Nombre de millisecondes à retarder.

abortSignal

AbortSignalLike

abortSignal associé à l’opération contenant.

abortErrorMsg

string

Message d’erreur d’abandon associé à l’opération contenante.

value

T

Valeur à résoudre après un délai d’attente de t millisecondes.

Retours

Promise<T | void>

• Promesse résolue

isMessagingError(MessagingError | Error)

Détermine si une erreur est un message d’erreur MessagingError.

function isMessagingError(error: MessagingError | Error): error

Paramètres

error

MessagingError | Error

Erreur qui peut être une erreur ou une erreur MessagingError.

Retours

error

isSystemError(unknown)

Vérifie si l’erreur fournie est une node.js SystemError.

function isSystemError(err: unknown): err

Paramètres

err

unknown

Objet qui peut contenir des informations d’erreur.

Retours

err

parseConnectionString<T>(string)

Analyse la chaîne de connexion et retourne un objet de type T.

Les chaînes de connexion ont la syntaxe suivante :

ConnectionString ::= Part { ";" Part } [ ";" ] [ WhiteSpace ] Part ::= [ PartLiteral [ « = » PartLiteral ] PartLiteral ::= [ WhiteSpace ] Littéral [ WhiteSpace ] Littéral ::= ? toute séquence de caractères à l’exception de ; ou = ou Espace blanc ? Espace blanc ::= ? tous les espaces blancs, y compris \r et \n ?

function parseConnectionString<T>(connectionString: string): ParsedOutput<T>

Paramètres

connectionString

string

Chaîne de connexion à analyser.

Retours

ParsedOutput<T>

ParsedOutput.

retry<T>(RetryConfig<T>)

Chaque opération est tentée au moins une fois. D’autres tentatives sont effectuées si la tentative précédente a échoué avec une erreur pouvant être réessayée. Le nombre de tentatives supplémentaires est régi par la maxRetries propriété fournie sur l’argument RetryConfig .

Si mode l’option a la Fixedvaleur , les nouvelles tentatives sont effectuées sur l’opération donnée pour un nombre spécifié de fois, avec un délai fixe entre chaque nouvelle tentative.

Si mode l’option a la Exponentialvaleur , le délai entre les nouvelles tentatives est ajusté pour augmenter de façon exponentielle à chaque tentative à l’aide du facteur d’arrêt de la puissance 2.

function retry<T>(config: RetryConfig<T>): Promise<T>

Paramètres

config

RetryConfig<T>

Paramètres pour configurer l’opération de nouvelle tentative

Retours

Promise<T>

Promesse.

translate(unknown)

Traduit l’erreur AMQP reçue au niveau de la couche de protocole ou d’une erreur SystemError en messageError. Toutes les autres erreurs sont retournées sans avoir été affectées.

function translate(err: unknown): MessagingError | Error

Paramètres

err

unknown

Erreur amqp reçue.

Retours

MessagingError | Error

Objet MessagingError.