@azure/core-amqp package

Clases

CbsClient	Describe el cliente de EventHub/ServiceBus Cbs que se comunica con el punto de conexión de $cbs a través de la conexión AMQP.
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.

Interfaces

AcquireLockProperties	Describe las propiedades que se deben proporcionar al adquirir un bloqueo.
AmqpAnnotatedMessage	Describe amqpAnnotatedMessage, parte de la propiedad ServiceBusReceivedMessage(as amqpAnnotatedMessage).
AmqpMessageHeader	Describe el conjunto definido de propiedades de encabezado estándar del mensaje.
AmqpMessageProperties	Describe el conjunto definido de propiedades estándar del mensaje.
CancellableAsyncLock	CancellableAsyncLock proporciona un mecanismo para forzar las tareas que usan la misma "clave" que se va a ejecutar en serie. Las tareas pendientes se pueden cancelar manualmente a través de abortSignal o cancelarse automáticamente mediante un valor de tiempo de espera proporcionado.
CbsResponse	Describe la respuesta CBS.
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.
ConnectionConfigOptions	Describe las opciones que se pueden proporcionar al crear una configuración de conexión.
ConnectionContextBase	Proporciona información contextual como la conexión amqp subyacente, la sesión cbs, tokenProvider, la configuración de conexión, el transformador de datos, etc.
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.
NetworkSystemError	Describe los campos de una Node.js SystemError. Omite los campos que no están relacionados con las llamadas de red (por ejemplo, llamadas del sistema de archivos). Consulte https://nodejs.org/dist/latest-v12.x/docs/api/errors.html#errors_class_systemerror
RetryConfig	Describe los parámetros que deben configurarse para la operación de reintento.
RetryOptions	Opciones de directiva de reintento que determinan el modo, el número de reintentos, el intervalo de reintento, etc.
SendRequestOptions	Describe las opciones que se pueden especificar al enviar una solicitud.
WebSocketOptions	Opciones para configurar el canalización de la conexión AMQP a través de sockets web.

Alias de tipos

ParsedOutput

Define un objeto con las posibles propiedades definidas en T.

Enumeraciones

ConditionErrorNameMapper	Asigna las condiciones de error amqp a los nombres de error.
ErrorNameConditionMapper	Asigna los nombres de error a las condiciones de error amqp.
RetryMode	Describe el tipo modo de reintento.
RetryOperationType	Describe el tipo de operación de reintento.
SystemErrorConditionMapper	Asigna algunos systemErrors a las condiciones de error amqp
TokenType	Describe el tipo de tokens admitidos.

Funciones

delay<T>(number, AbortSignalLike, string, T)	Contenedor para setTimeout que resuelve una promesa después de milisegundos.
isMessagingError(MessagingError | Error)	Determina si un error es MessagingError.
isSystemError(unknown)	Comprueba si el error proporcionado es un node.js SystemError.
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 ::= Part { ";" Part } [ ";" ] [ 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 ?
retry<T>(RetryConfig<T>)	Cada operación se intenta al menos una vez. Se realizan intentos adicionales si se produjo un error en el intento anterior con un error que se puede reintentar. El número de intentos adicionales se rige por la propiedad maxRetries proporcionada en el argumento RetryConfig. Si mode opción se establece en Fixed, los reintentos se realizan en la operación especificada durante un número especificado de veces, con un retraso fijo entre cada reintento cada vez. Si mode opción se establece en Exponential, el retraso entre reintentos se ajusta para aumentar exponencialmente con cada intento mediante el factor de retroceso de energía 2.
translate(unknown)	Traduce el error AMQP recibido en la capa de protocolo o un SystemError en un MessagingError. Todos los demás errores se devuelven sin modificar.

Detalles de la función

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

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

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

Parámetros

delayInMs

number

Número de milisegundos que se van a retrasar.

abortSignal

AbortSignalLike

AbortSignal asociado a la operación contenedora.

abortErrorMsg

string

Mensaje de error de anulación asociado a la operación contenedora.

value

T

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

Devoluciones

Promise<T | void>

• Promesa resuelta

isMessagingError(MessagingError | Error)

Determina si un error es MessagingError.

function isMessagingError(error: MessagingError | Error): error

Parámetros

error

MessagingError | Error

Un error que puede ser un error o un MessagingError.

Devoluciones

error

isSystemError(unknown)

Comprueba si el error proporcionado es un node.js SystemError.

function isSystemError(err: unknown): err

Parámetros

err

unknown

Objeto que puede contener información de error.

Devoluciones

err

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 ::= Part { ";" Part } [ ";" ] [ 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.

retry<T>(RetryConfig<T>)

Cada operación se intenta al menos una vez. Se realizan intentos adicionales si se produjo un error en el intento anterior con un error que se puede reintentar. El número de intentos adicionales se rige por la propiedad maxRetries proporcionada en el argumento RetryConfig.

Si mode opción se establece en Fixed, los reintentos se realizan en la operación especificada durante un número especificado de veces, con un retraso fijo entre cada reintento cada vez.

Si mode opción se establece en Exponential, el retraso entre reintentos se ajusta para aumentar exponencialmente con cada intento mediante el factor de retroceso de energía 2.

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>

Prometer.

translate(unknown)

Traduce el error AMQP recibido en la capa de protocolo o un SystemError en un MessagingError. Todos los demás errores se devuelven sin modificar.

function translate(err: unknown): MessagingError | Error

Parámetros

err

unknown

Error amqp que se recibió.

Devoluciones

MessagingError | Error

MessagingError (objeto).