@azure/amqp-common package

Clases

AsyncLock
AadTokenProvider	Define tokenProvider de AAD (Azure ActiveDirectory). Esto acepta las siguientes credenciales del paquete de @azure/ms-rest-nodeauth: ApplicationTokenCredentials UserTokenCredentials DeviceTokenCredentials MSITokenCredentials (MSIVmTokenCredentials)
CbsClient
DefaultDataTransformer	Transformador de datos predeterminado que usará el SDK de Azure.
MessagingError	Describe la clase base para Error de mensajería.
RequestResponseLink	Describe un vínculo amqp request(sender)-response(receiver) que se crea a través de una sesión amqp.
SasTokenProvider
Timeout	Describe una clase Timeout que puede esperar la cantidad de tiempo especificada y, a continuación, resolver o rechazar la promesa con el valor especificado.

Interfaces

AsyncLockOptions
ConnectionConfig	Describe el objeto de configuración de conexión que se crea después de analizar una cadena de conexión de EventHub o ServiceBus.
ConnectionContextBase
EventHubConnectionConfig	Describe el objeto de configuración de conexión que se crea después de analizar una cadena de conexión de EventHub. También proporciona algunos métodos de conveniencia para obtener la dirección y la audiencia de diferentes entidades.
MessageHeader	Describe el conjunto definido de propiedades de encabezado estándar del mensaje.
MessageProperties	Describe el conjunto definido de propiedades estándar del mensaje.
AmqpMessage	Describe el mensaje AMQP que se envía o recibe en la conexión.
AmqpMessageHeader	Describe el conjunto definido de propiedades de encabezado estándar del mensaje.
AmqpMessageProperties	Describe el conjunto definido de propiedades estándar del mensaje.
AsyncLockOptions	Describe las opciones que se pueden proporcionar para crear un bloqueo asincrónico.
CbsResponse	Describe la respuesta CBS.
ConnectionConfigOptions	Describe las opciones que se pueden proporcionar al crear una configuración de conexión.
ConnectionProperties	Define las propiedades que deben establecerse al establecer la conexión AMQP.
CreateConnectionContextBaseParameters	Describe los parámetros que se pueden proporcionar para crear el contexto de conexión base.
DataTransformer	Describe las transformaciones que se pueden realizar para codificar o descodificar los datos antes de enviarlos (o recibirlos desde) la conexión.
Dictionary	Proporciona un diccionario como la estructura <clave, el valor> de tipo T.
EventHubConnectionStringModel	Describe el modelo de cadena de conexión del centro de eventos.
IotHubConnectionStringModel	Describe el modelo de cadena de conexión de iothub.
RetryConfig	Describe los parámetros que deben configurarse para la operación de reintento.
SendRequestOptions	Describe las opciones que se pueden especificar al enviar una solicitud.
ServiceBusConnectionStringModel	Describe el modelo de cadena de conexión de servicebus.
StorageConnectionStringModel	Describe el modelo de cadena de conexión de estroage.
TokenInfo	Proporciona información sobre el token.
TokenProvider	Describe el proveedor de tokens base.

Alias de tipos

AsyncLockDoneCallback
Func	Declaración de tipo para un tipo de función donde T es la entrada de la función y V es la salida de la función.
ParsedOutput	Define un objeto con las posibles propiedades definidas en T.

Enumeraciones

ConditionErrorNameMapper	Asigna las condiciones de error amqp a los nombres de error.
ConditionStatusMapper	Asigna las condiciones a los códigos numéricos de estado de respuesta de AMQP.
ErrorNameConditionMapper	Asigna los nombres de error a las condiciones de error amqp.
RetryOperationType	Describe el tipo de operación de reintento. RetryOperationType
SystemErrorConditionMapper	Asigna algunos SytemErrors a las condiciones de error amqp SystemErrorConditionMapper
TokenType	Describe el tipo de tokens admitidos. TokenType

Funciones

delay<T>(number, T)	Contenedor para setTimeout que resuelve una promesa después de milisegundos.
executePromisesSequentially(any[], any)
getNewAsyncLock(AsyncLockOptions)	Obtiene una nueva instancia del bloqueo asincrónico con la configuración deseada.
isAmqpError(any)	Determina si el objeto de error especificado es como un objeto AmqpError.
isIotHubConnectionString(string)	Determina si la cadena de conexión especificada es una cadena de conexión de iothub.
isSystemError(any)
parseConnectionString<T>(string)	Analiza la cadena de conexión y devuelve un objeto de tipo T. Las cadenas de conexión tienen la sintaxis siguiente: ConnectionString ::= Parte { ";" Parte } [ ";" ] [ WhiteSpace ] Parte ::= [ PartLiteral [ "=" PartLiteral ] ] PartLiteral ::= [ WhiteSpace ] Literal [ WhiteSpace ] Literal ::= ? cualquier secuencia de caracteres excepto ; o = o Espacio en blanco ? Espacio en blanco ::= ? todos los caracteres de espacio en blanco, incluidos \r y \n ?
randomNumberFromInterval(number, number)	Genera un número aleatorio entre el intervalo especificado.
retry<T>(RetryConfig<T>)	Intentará volver a intentar linealmente una operación especificada número de veces con un retraso especificado entre cada reintento. Los reintentos solo se producirán si se puede reintentar el error.
translate(Error | AmqpError)	Traduce el error de AQMP recibido en la capa de protocolo o un error genérico en un MessagingError.

Variables

defaultLock
isNode	Una constante que indica si el entorno es node.js o basado en navegador.
retryableErrors	Proporciona una lista de errores AMQP reprobables. "ErrorDeServidorInterno", "ErrorOcupadoDeServidor", "ErrorIndisponibleServicio", "ErrorAnuladoOperación", "ErrorOcupadoEnviador", "ErrorMensajería", "ErrorForzadoDetacho", "ErrorForzadoConexión", "ErrorLímiteExcedidoError", "ErrorTiempoLímiteOperativoSalida"

Detalles de la función

delay<T>(number, T)

Contenedor para setTimeout que resuelve una promesa después de milisegundos.

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

Parámetros

t

number

Número de milisegundos que se van a retrasar.

value

T

Valor que se va a resolver con después de un tiempo de espera de milisegundos.

Devoluciones

Promise<T>

• Promesa resuelta

executePromisesSequentially(any[], any)

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

Parámetros

promiseFactories

any[]

kickstart

any

Devoluciones

Promise<any>

getNewAsyncLock(AsyncLockOptions)

Obtiene una nueva instancia del bloqueo asincrónico con la configuración deseada.

function getNewAsyncLock(options?: AsyncLockOptions): AsyncLock

Parámetros

options

AsyncLockOptions

Las opciones de bloqueo asincrónico.

Devoluciones

AsyncLock

AsyncLock

isAmqpError(any)

Determina si el objeto de error especificado es como un objeto AmqpError.

function isAmqpError(err: any): boolean

Parámetros

err

any

El objeto AmqpError

Devoluciones

boolean

result: true si es un error AMQP; false de lo contrario.

isIotHubConnectionString(string)

Determina si la cadena de conexión especificada es una cadena de conexión de iothub.

function isIotHubConnectionString(connectionString: string): boolean

Parámetros

connectionString

string

Cadena de conexión.

Devoluciones

boolean

booleano.

isSystemError(any)

function isSystemError(err: any): boolean

Parámetros

err

any

Devoluciones

boolean

parseConnectionString<T>(string)

Analiza la cadena de conexión y devuelve un objeto de tipo T.

Las cadenas de conexión tienen la sintaxis siguiente:

ConnectionString ::= Parte { ";" Parte } [ ";" ] [ WhiteSpace ] Parte ::= [ PartLiteral [ "=" PartLiteral ] ] PartLiteral ::= [ WhiteSpace ] Literal [ WhiteSpace ] Literal ::= ? cualquier secuencia de caracteres excepto ; o = o Espacio en blanco ? Espacio en blanco ::= ? todos los caracteres de espacio en blanco, incluidos \r y \n ?

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

Parámetros

connectionString

string

Cadena de conexión que se va a analizar.

Devoluciones

ParsedOutput<T>

ParsedOutput<T>.

randomNumberFromInterval(number, number)

Genera un número aleatorio entre el intervalo especificado.

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

Parámetros

min

number

Número mínimo del intervalo (inclusivo).

max

number

Número máximo del intervalo (incluido).

Devoluciones

number

retry<T>(RetryConfig<T>)

Intentará volver a intentar linealmente una operación especificada número de veces con un retraso especificado entre cada reintento. Los reintentos solo se producirán si se puede reintentar el error.

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

Parámetros

config

RetryConfig<T>

Parámetros para configurar la operación de reintento.

Devoluciones

Promise<T>

Promesa<T>.

translate(Error | AmqpError)

Traduce el error de AQMP recibido en la capa de protocolo o un error genérico en un MessagingError.

function translate(err: Error | AmqpError): MessagingError

Parámetros

err

Error | AmqpError

Error amqp que se recibió.

Devoluciones

MessagingError

MessagingError (objeto).

Variable Details

defaultLock

defaultLock: AsyncLock

Tipo

AsyncLock

isNode

Una constante que indica si el entorno es node.js o basado en navegador.

isNode: boolean

Tipo

boolean

retryableErrors

Proporciona una lista de errores AMQP reprobables. "ErrorDeServidorInterno", "ErrorOcupadoDeServidor", "ErrorIndisponibleServicio", "ErrorAnuladoOperación", "ErrorOcupadoEnviador", "ErrorMensajería", "ErrorForzadoDetacho", "ErrorForzadoConexión", "ErrorLímiteExcedidoError", "ErrorTiempoLímiteOperativoSalida"

retryableErrors: string[]

Tipo

string[]