@azure/amqp-common package

Classes

AsyncLock
AadTokenProvider	Define o TokenProvider do AAD (Azure ActiveDirectory). Isso aceita as seguintes credenciais do pacote de `@azure/ms-rest-nodeauth`: ApplicationTokenCredentials UserTokenCredentials DeviceTokenCredentials MSITokenCredentials (MSIVmTokenCredentials)
CbsClient
DefaultDataTransformer	O transformador de dados padrão que será usado pelo SDK do Azure.
MessagingError	Descreve a classe base para Erro de Mensagens.
RequestResponseLink	Descreve um link amqp request(sender)-response(receiver) criado em uma sessão amqp.
SasTokenProvider
Timeout	Descreve uma classe Timeout que pode aguardar a quantidade de tempo especificada e, em seguida, resolver/rejeitar a promessa com o valor fornecido.

Interfaces

AsyncLockOptions
ConnectionConfig	Descreve o objeto de configuração de conexão criado após a análise de uma cadeia de conexão EventHub ou ServiceBus.
ConnectionContextBase
EventHubConnectionConfig	Descreve o objeto de configuração de conexão criado após a análise de uma cadeia de conexão do EventHub. Ele também fornece alguns métodos de conveniência para obter o endereço e o público para diferentes entidades.
MessageHeader	Descreve o conjunto definido de propriedades de cabeçalho padrão da mensagem.
MessageProperties	Descreve o conjunto definido de propriedades padrão da mensagem.
AmqpMessage	Descreve a mensagem AMQP que é enviada ou recebida na transmissão.
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.
AsyncLockOptions	Descreve as opções que podem ser fornecidas para criar um bloqueio assíncrono.
CbsResponse	Descreve a resposta da CBS.
ConnectionConfigOptions	Descreve as opções que podem ser fornecidas durante a criação de uma configuração de conexão.
ConnectionProperties	Define as propriedades que precisam ser definidas ao estabelecer a conexão AMQP.
CreateConnectionContextBaseParameters	Descreve os parâmetros que podem ser fornecidos para criar o contexto de conexão base.
DataTransformer	Descreve as transformações que podem ser executadas para codificar/decodificar os dados antes de enviá-los (ou recebê-los) do fio.
Dictionary	Fornece um dicionário como estrutura <Chave,> de Valor do Tipo T.
EventHubConnectionStringModel	Descreve o modelo de cadeia de conexão do eventhub.
IotHubConnectionStringModel	Descreve o modelo de cadeia de conexão do iothub.
RetryConfig	Descreve os parâmetros que precisam ser configurados para a operação de repetição.
SendRequestOptions	Descreve as opções que podem ser especificadas ao enviar uma solicitação.
ServiceBusConnectionStringModel	Descreve o modelo de cadeia de conexão do servicebus.
StorageConnectionStringModel	Descreve o modelo de cadeia de conexão de estrogonofe.
TokenInfo	Fornece informações sobre o token.
TokenProvider	Descreve o provedor de token base.

Aliases de tipo

AsyncLockDoneCallback
Func	Declaração de tipo para um tipo de função em que T é a entrada para a função e V é a saída da função.
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.
ConditionStatusMapper	Mapeia as condições para os códigos de status de resposta AMQP numéricos.
ErrorNameConditionMapper	Mapeia os nomes de erro para as condições de erro amqp.
RetryOperationType	Descreve o tipo de operação de repetição. RetryOperationType
SystemErrorConditionMapper	Mapeia alguns SytemErrors para condições de erro amqp SystemErrorConditionMapper
TokenType	Descreve o tipo de tokens com suporte. TokenType

Funções

delay<T>(number, T)	Um wrapper para setTimeout que resolve uma promessa após milissegundos.
executePromisesSequentially(any[], any)
getNewAsyncLock(AsyncLockOptions)	Obtém uma nova instância do bloqueio assíncrono com as configurações desejadas.
isAmqpError(any)	Determina se o objeto de erro fornecido é como um objeto AmqpError.
isIotHubConnectionString(string)	Determina se a cadeia de conexão fornecida é uma cadeia de conexão iothub.
isSystemError(any)
parseConnectionString<T>(string)	Analisa a cadeia de conexão e retorna um objeto do tipo T. As cadeias de conexão têm a seguinte sintaxe: ConnectionString ::= Parte { ";" Part } [ ";" ] [ WhiteSpace ] Parte ::= [ PartLiteral [ "=" PartLiteral ] ] PartLiteral ::= [ WhiteSpace ] Literal [ WhiteSpace ] Literal ::= ? qualquer sequência de caracteres, exceto ; ou = ou WhiteSpace? Espaço em branco ::= ? todos os caracteres de espaço em branco, incluindo \r e \n?
randomNumberFromInterval(number, number)	Gera um número aleatório entre o intervalo determinado
retry<T>(RetryConfig<T>)	Ele tentará repetir linearmente uma operação especificada várias vezes com um atraso especificado entre cada repetição. As novas tentativas só ocorrerão se o erro for repetível.
translate(Error \| AmqpError)	Converte o erro do AQMP recebido na camada de protocolo ou um erro genérico em um MessagingError.

Variáveis

defaultLock
isNode	Uma constante que indica se o ambiente é node.js ou baseado em navegador.
retryableErrors	Fornece uma lista de erros AMQP retentáveis. "ErrorServidorDeInterno", "ErrorOcupadoDeServidor", "ErroIndisponívelServiço", "ErrorCanceladoOperação", "ErrorOcupadoEnviador", "ErrorMensagemEErrado", "ErrorForçadoDetache", "ErrorForçadoConexão", "LimitExcedidoErroExcedidoErro", "ErrorOperacionalTempoSaída"

Detalhes da função

delay<T>(number, T)

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

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

Parâmetros

t: number

O número de milissegundos a serem atrasados.

value: T

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

Retornos

Promise<T>

Promessa resolvida

executePromisesSequentially(any[], any)

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

Parâmetros

promiseFactories: any[]

kickstart: any

Retornos

Promise<any>

getNewAsyncLock(AsyncLockOptions)

Obtém uma nova instância do bloqueio assíncrono com as configurações desejadas.

function getNewAsyncLock(options?: AsyncLockOptions): AsyncLock

Parâmetros

options: AsyncLockOptions

As opções de bloqueio assíncrono.

Retornos

AsyncLock

isAmqpError(any)

Determina se o objeto de erro fornecido é como um objeto AmqpError.

function isAmqpError(err: any): boolean

Parâmetros

err: any

O objeto AmqpError

Retornos

boolean

resultado – true se for um erro AMQP; false caso contrário.

isIotHubConnectionString(string)

Determina se a cadeia de conexão fornecida é uma cadeia de conexão iothub.

function isIotHubConnectionString(connectionString: string): boolean

Parâmetros

connectionString: string

A cadeia de conexão.

Retornos

boolean

booleano.

isSystemError(any)

function isSystemError(err: any): boolean

Parâmetros

err: any

Retornos

boolean

parseConnectionString<T>(string)

Analisa a cadeia de conexão e retorna um objeto do tipo T.

As cadeias de conexão têm a seguinte sintaxe:

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

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

Parâmetros

connectionString: string

A cadeia de conexão a ser analisada.

Retornos

ParsedOutput<T>

ParsedOutput<T>.

randomNumberFromInterval(number, number)

Gera um número aleatório entre o intervalo determinado

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

Parâmetros

min: number

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

max: number

Número máximo do intervalo (inclusivo).

Retornos

number

retry<T>(RetryConfig<T>)

Ele tentará repetir linearmente uma operação especificada várias vezes com um atraso especificado entre cada repetição. As novas tentativas só ocorrerão se o erro for repetível.

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

Parâmetros

config: RetryConfig<T>

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

Retornos

Promise<T>

Promessa<T>.

translate(Error | AmqpError)

Converte o erro do AQMP recebido na camada de protocolo ou um erro genérico em um MessagingError.

function translate(err: Error | AmqpError): MessagingError

Parâmetros

err: Error | AmqpError

O erro amqp que foi recebido.

Retornos

MessagingError

Objeto MessagingError.

Variable Details

defaultLock

defaultLock: AsyncLock

Tipo

AsyncLock

isNode

Uma constante que indica se o ambiente é node.js ou baseado em navegador.

isNode: boolean

Tipo

boolean

retryableErrors

Fornece uma lista de erros AMQP retentáveis. "ErrorServidorDeInterno", "ErrorOcupadoDeServidor", "ErroIndisponívelServiço", "ErrorCanceladoOperação", "ErrorOcupadoEnviador", "ErrorMensagemEErrado", "ErrorForçadoDetache", "ErrorForçadoConexão", "LimitExcedidoErroExcedidoErro", "ErrorOperacionalTempoSaída"

retryableErrors: string[]

Tipo

string[]

Comentários

Esta página foi útil?