@azure/amqp-common package

Classes

AsyncLock
AadTokenProvider	Définit le jeton AAD (Azure ActiveDirectory). Cela accepte les informations d’identification suivantes du package `@azure/ms-rest-nodeauth` : ApplicationTokenCredentials UserTokenCredentials DeviceTokenCredentials MSITokenCredentials (MSIVmTokenCredentials)
CbsClient
DefaultDataTransformer	Transformateur de données par défaut qui sera utilisé par le Kit de développement logiciel (SDK) Azure.
MessagingError	Décrit la classe de base pour l’erreur de messagerie.
RequestResponseLink	Décrit un lien amqp request(sender)-response(receiver) créé sur une session amqp.
SasTokenProvider
Timeout	Décrit une classe Timeout qui peut attendre la durée spécifiée, puis résoudre/rejeter la promesse avec la valeur donnée.

Interfaces

AsyncLockOptions
ConnectionConfig	Décrit l’objet de configuration de connexion créé après l’analyse d’une chaîne de connexion EventHub ou ServiceBus.
ConnectionContextBase
EventHubConnectionConfig	Décrit l’objet de configuration de connexion créé après l’analyse d’une chaîne de connexion EventHub. Il fournit également des méthodes pratiques pour obtenir l’adresse et l’audience pour différentes entités.
MessageHeader	Décrit l’ensemble défini de propriétés d’en-tête standard du message.
MessageProperties	Décrit l’ensemble défini de propriétés standard du message.
AmqpMessage	Décrit le message AMQP envoyé ou reçu sur le câble.
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.
AsyncLockOptions	Décrit les options qui peuvent être fournies pour créer un verrou asynchrone.
CbsResponse	Décrit la réponse CBS.
ConnectionConfigOptions	Décrit les options qui peuvent être fournies lors de la création d’une configuration de connexion.
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.
DataTransformer	Décrit les transformations qui peuvent être effectuées pour encoder/décoder les données avant de les envoyer (ou de les recevoir) du câble.
Dictionary	Fournit un dictionnaire tel que la structure <clé, la valeur> de type T.
EventHubConnectionStringModel	Décrit le modèle de chaîne de connexion eventhub.
IotHubConnectionStringModel	Décrit le modèle de chaîne de connexion iothub.
RetryConfig	Décrit les paramètres qui doivent être configurés pour l’opération de nouvelle tentative.
SendRequestOptions	Décrit les options qui peuvent être spécifiées lors de l’envoi d’une demande.
ServiceBusConnectionStringModel	Décrit le modèle de chaîne de connexion servicebus.
StorageConnectionStringModel	Décrit le modèle de chaîne de connexion stroage.
TokenInfo	Fournit des informations sur le jeton.
TokenProvider	Décrit le fournisseur de jetons de base.

Alias de type

AsyncLockDoneCallback
Func	Déclaration de type pour un type de fonction où T est l’entrée de la fonction et V est la sortie de la fonction.
ParsedOutput	Définit un objet avec les propriétés possibles définies dans T.

Énumérations

ConditionErrorNameMapper	Mappe les conditions d’erreur amqp aux noms d’erreurs.
ConditionStatusMapper	Mappe les conditions aux codes d’état de réponse AMQP numériques.
ErrorNameConditionMapper	Mappe les noms d’erreurs aux conditions d’erreur amqp.
RetryOperationType	Décrit le type d’opération de nouvelle tentative. RetryOperationType
SystemErrorConditionMapper	Mappe certains SytemErrors aux conditions d’erreur amqp SystemErrorConditionMapper
TokenType	Décrit le type de jetons pris en charge. TokenType

Functions

delay<T>(number, T)	Wrapper pour setTimeout qui résout une promesse après t millisecondes.
executePromisesSequentially(any[], any)
getNewAsyncLock(AsyncLockOptions)	Obtient une nouvelle instance du verrou asynchrone avec les paramètres souhaités.
isAmqpError(any)	Détermine si l’objet d’erreur donné est semblable à un objet AmqpError.
isIotHubConnectionString(string)	Détermine si la chaîne de connexion donnée est une chaîne de connexion iothub.
isSystemError(any)
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 [ WhiteSpace ] Littéral ::= ? n’importe quelle séquence de caractères sauf ; ou = ou WhiteSpace ? Espace ::= ? tous les espaces blancs, y compris \r et \n ?
randomNumberFromInterval(number, number)	Génère un nombre aléatoire entre l’intervalle donné
retry<T>(RetryConfig<T>)	Il tente de réessayer linéairement une opération spécifiée plusieurs fois avec un délai spécifié entre chaque nouvelle tentative. Les nouvelles tentatives se produisent uniquement si l’erreur est retentable.
translate(Error \| AmqpError)	Traduit l’erreur AQMP reçue au niveau de la couche de protocole ou d’une erreur générique en message MessagingError.

Variables

defaultLock
isNode	Une constante qui indique si l’environnement est node.js ou basé sur un navigateur.
retryableErrors	Fournit une liste d’erreurs AMQP réessayables. « ErrorServerIntérip », « ErrorServeurOccupé », « ErrorIndisponibleServie », « ErrorAnnuléD’Opération », « ErrorOccupéEnvaheur », « ErrorMessageMessage », « ErrorForcedIncorrect », « ErrorForcedConnexion », « ErrorLimitTransférExceededError », « ErrorTempsSortieOpération »

Informations relatives à la fonction

delay<T>(number, T)

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

function delay<T>(t: number, value?: T): Promise<T>

Paramètres

t: number

Nombre de millisecondes à retarder.

value: T

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

Retours

Promise<T>

Promesse résolue

executePromisesSequentially(any[], any)

function executePromisesSequentially(promiseFactories: any[], kickstart?: any): Promise<any>

Paramètres

promiseFactories: any[]

kickstart: any

Retours

Promise<any>

getNewAsyncLock(AsyncLockOptions)

Obtient une nouvelle instance du verrou asynchrone avec les paramètres souhaités.

function getNewAsyncLock(options?: AsyncLockOptions): AsyncLock

Paramètres

options: AsyncLockOptions

Options de verrouillage asynchrone.

Retours

AsyncLock

isAmqpError(any)

Détermine si l’objet d’erreur donné est semblable à un objet AmqpError.

function isAmqpError(err: any): boolean

Paramètres

err: any

Objet AmqpError

Retours

boolean

résultat : true s’il s’agit d’une erreur AMQP ; false sinon.

isIotHubConnectionString(string)

Détermine si la chaîne de connexion donnée est une chaîne de connexion iothub.

function isIotHubConnectionString(connectionString: string): boolean

Paramètres

connectionString: string

Chaîne de connexion.

Retours

boolean

booléen.

isSystemError(any)

function isSystemError(err: any): boolean

Paramètres

err: any

Retours

boolean

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 [ WhiteSpace ] Littéral ::= ? n’importe quelle séquence de caractères sauf ; ou = ou WhiteSpace ? Espace ::= ? 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<T>.

randomNumberFromInterval(number, number)

Génère un nombre aléatoire entre l’intervalle donné

function randomNumberFromInterval(min: number, max: number): number

Paramètres

min: number

Nombre minimal de la plage (inclusive).

max: number

Nombre maximal de la plage (inclusive).

Retours

number

retry<T>(RetryConfig<T>)

Il tente de réessayer linéairement une opération spécifiée plusieurs fois avec un délai spécifié entre chaque nouvelle tentative. Les nouvelles tentatives se produisent uniquement si l’erreur est retentable.

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<T>.

translate(Error | AmqpError)

Traduit l’erreur AQMP reçue au niveau de la couche de protocole ou d’une erreur générique en message MessagingError.

function translate(err: Error | AmqpError): MessagingError

Paramètres

err: Error | AmqpError

Erreur amqp reçue.

Retours

MessagingError

Objet MessagingError.

Variable Details

defaultLock

defaultLock: AsyncLock

Type

AsyncLock

isNode

Une constante qui indique si l’environnement est node.js ou basé sur un navigateur.

isNode: boolean

Type

boolean

retryableErrors

Fournit une liste d’erreurs AMQP réessayables. « ErrorServerIntérip », « ErrorServeurOccupé », « ErrorIndisponibleServie », « ErrorAnnuléD’Opération », « ErrorOccupéEnvaheur », « ErrorMessageMessage », « ErrorForcedIncorrect », « ErrorForcedConnexion », « ErrorLimitTransférExceededError », « ErrorTempsSortieOpération »

retryableErrors: string[]

Type

string[]

Commentaires

Cette page a-t-elle été utile ?