@azure/core-amqp package

Classes

CbsClient	Descreve o cliente EventHub/ServiceBus Cbs que comunica com o ponto final $cbs através da ligação AMQP.
MessagingError	Descreve a classe base para Erro de Mensagens.
RequestResponseLink	Descreve uma ligação amqp request(sender)-response(receiver) que é criada numa sessão amqp.

Interfaces

AcquireLockProperties	Descreve as propriedades que têm de ser fornecidas ao adquirir um bloqueio.
AmqpAnnotatedMessage	Descreve AmqpAnnotatedMessage, parte da propriedade ServiceBusReceivedMessage(como amqpAnnotatedMessage ).
AmqpMessageHeader	Descreve o conjunto definido de propriedades de cabeçalho padrão da mensagem.
AmqpMessageProperties	Descreve o conjunto definido de propriedades padrão da mensagem.
CancellableAsyncLock	CancellableAsyncLock fornece um mecanismo para forçar tarefas com a mesma "chave" a ser executada em série. As tarefas pendentes podem ser canceladas manualmente através de um abortSignal ou automaticamente canceladas ao atingir um valor de tempo limite fornecido.
CbsResponse	Descreve a Resposta da CBS.
ConnectionConfig	Descreve o objeto de configuração de ligação que é criado após analisar uma cadeia de ligação eventHub ou ServiceBus.
ConnectionConfigOptions	Descreve as opções que podem ser fornecidas ao criar uma configuração de ligação.
ConnectionContextBase	Fornece informações contextuais como a ligação amqp subjacente, sessão cbs, tokenProvider, Configuração da ligação, transformador de dados, etc.
ConnectionProperties	Define as propriedades que têm de ser definidas ao estabelecer a ligação AMQP.
CreateConnectionContextBaseParameters	Descreve os parâmetros que podem ser fornecidos para criar o contexto de ligação base.
NetworkSystemError	Descreve os campos num Node.js SystemError. Omite campos que não estão relacionados com chamadas de rede (por exemplo, chamadas do sistema de ficheiros). Veja https://nodejs.org/dist/latest-v12.x/docs/api/errors.html#errors_class_systemerror
RetryConfig	Descreve os parâmetros que têm de ser configurados para a operação de repetição.
RetryOptions	Repita as opções de política que determinam o modo, o número de repetições, o intervalo de repetição, etc.
SendRequestOptions	Descreve as opções que podem ser especificadas ao enviar um pedido.
WebSocketOptions	Opções para configurar a canalização da ligação AMQP através de Sockets Web.

Aliases de Tipo

ParsedOutput

Define um objeto com possíveis propriedades definidas em T.

Enumerações

ConditionErrorNameMapper	Mapeia as condições de erro amqp para os Nomes de erro.
ErrorNameConditionMapper	Mapeia os Nomes de erro para as condições de erro amqp.
RetryMode	Descreve o tipo modo de repetição
RetryOperationType	Descreve o tipo de operação de repetição.
SystemErrorConditionMapper	Mapeia alguns SystemErrors para condições de erro amqp
TokenType	Descreve o tipo de tokens suportados.

Funções

delay<T>(number, AbortSignalLike, string, T)	Um wrapper para setTimeout que resolve uma promessa após t milissegundos.
isMessagingError(Error | MessagingError)	Determina se um erro é messagingError.
isSystemError(unknown)	Verifica se o erro fornecido é um node.js SystemError.
parseConnectionString<T>(string)	Analisa a cadeia de ligação e devolve um objeto do tipo T. As cadeias de ligação têm a seguinte sintaxe: ConnectionString ::= Part { ";" Part } [ ";" ] [ WhiteSpace ] Parte ::= [ PartLiteral [ "=" PartLiteral ] ] PartLiteral ::= [ WhiteSpace ] Literal [ WhiteSpace ] Literal ::= ? qualquer sequência de carateres, exceto ; ou = ou WhiteSpace? Espaço Em Branco ::= ? todos os carateres de espaço em branco, incluindo \r e \n ?
retry<T>(RetryConfig<T>)	Cada operação é tentada pelo menos uma vez. Serão efetuadas tentativas adicionais se a tentativa anterior tiver falhado com um erro de repetição. O número de tentativas adicionais é regido pela maxRetries propriedade fornecida no RetryConfig argumento . Se mode a opção estiver definida como Fixed, as repetições são efetuadas na operação especificada por um número especificado de vezes, com um atraso fixo entre cada repetição de cada vez. Se mode a opção estiver definida como Exponential, o atraso entre repetições é ajustado para aumentar exponencialmente com cada tentativa utilizando o fator de ativação de energia 2.
translate(unknown)	Traduz o erro AMQP recebido na camada do protocolo ou um SystemError num MessagingError. Todos os outros erros são devolvidos sem serem modificados.

Detalhes de Função

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

Um wrapper para setTimeout que resolve uma promessa após t milissegundos.

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

Parâmetros

delayInMs

number

O número de milissegundos a atrasar.

abortSignal

AbortSignalLike

O abortSignal associado à operação de contenção.

abortErrorMsg

string

A mensagem de erro de abortação associada à operação de contenção.

value

T

O valor a ser resolvido após um tempo limite de t milissegundos.

Devoluções

Promise<T | void>

• Promessa resolvida

isMessagingError(Error | MessagingError)

Determina se um erro é messagingError.

function isMessagingError(error: Error | MessagingError): error

Parâmetros

error

Error | MessagingError

Um erro que pode ser um Erro ou um MessagingError.

Devoluções

error

isSystemError(unknown)

Verifica se o erro fornecido é um node.js SystemError.

function isSystemError(err: unknown): err

Parâmetros

err

unknown

Um objeto que pode conter informações de erro.

Devoluções

err

parseConnectionString<T>(string)

Analisa a cadeia de ligação e devolve um objeto do tipo T. As cadeias de ligação têm a seguinte sintaxe:

ConnectionString ::= Part { ";" Part } [ ";" ] [ WhiteSpace ] Parte ::= [ PartLiteral [ "=" PartLiteral ] ] PartLiteral ::= [ WhiteSpace ] Literal [ WhiteSpace ] Literal ::= ? qualquer sequência de carateres, exceto ; ou = ou WhiteSpace? Espaço Em Branco ::= ? todos os carateres de espaço em branco, incluindo \r e \n ?

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

Parâmetros

connectionString

string

A cadeia de ligação a analisar.

Devoluções

ParsedOutput<T>

ParsedOutput.

retry<T>(RetryConfig<T>)

Cada operação é tentada pelo menos uma vez. Serão efetuadas tentativas adicionais se a tentativa anterior tiver falhado com um erro de repetição. O número de tentativas adicionais é regido pela maxRetries propriedade fornecida no RetryConfig argumento . Se mode a opção estiver definida como Fixed, as repetições são efetuadas na operação especificada por um número especificado de vezes, com um atraso fixo entre cada repetição de cada vez.

Se mode a opção estiver definida como Exponential, o atraso entre repetições é ajustado para aumentar exponencialmente com cada tentativa utilizando o fator de ativação de energia 2.

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

Parâmetros

config

RetryConfig<T>

Parâmetros para configurar a operação de repetição

Devoluções

Promise<T>

Prometa.

translate(unknown)

Traduz o erro AMQP recebido na camada do protocolo ou um SystemError num MessagingError. Todos os outros erros são devolvidos sem serem modificados.

function translate(err: unknown): MessagingError | Error

Parâmetros

err

unknown

O erro amqp que foi recebido.

Devoluções

MessagingError | Error

Objeto MessagingError.