@azure/amqp-common package

Classes

AsyncLock
AadTokenProvider	Define o AAD (Azure ActiveDirectory) TokenProvider. Isso aceita as seguintes credenciais do pacote `@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) que é 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 que é 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 que é criado após a análise de uma cadeia de conexão 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 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 realizadas para codificar/decodificar os dados antes de enviá-los (ou recebê-los de) o fio.
Dictionary	Fornece um dicionário como estrutura <chave, valor> do tipo T.
EventHubConnectionStringModel	Descreve o modelo de cadeia de conexão do hub de eventos.
IotHubConnectionStringModel	Descreve o modelo de cadeia de conexão iothub.
RetryConfig	Descreve os parâmetros que precisam ser configurados para a operação de nova tentativa.
SendRequestOptions	Descreve as opções que podem ser especificadas durante o envio de uma solicitação.
ServiceBusConnectionStringModel	Descreve o modelo de cadeia de conexão do servicebus.
StorageConnectionStringModel	Descreve o modelo de cadeia de conexão stroage.
TokenInfo	Fornece informações sobre o token.
TokenProvider	Descreve o provedor de token base.

Alias de Tipo

AsyncLockDoneCallback
Func	Declaração de tipo para um tipo de função onde 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.

Enums

ConditionErrorNameMapper	Mapeia as condições de erro amqp para os nomes de erro.
ConditionStatusMapper	Mapeia as condições para os códigos numéricos de status AMQP Response.
ErrorNameConditionMapper	Mapeia os nomes de erro para as condições de erro amqp.
RetryOperationType	Descreve o tipo de operação de nova tentativa. RetryOperationType
SystemErrorConditionMapper	Mapeia alguns SytemErrors para condições de erro amqp SystemErrorConditionMapper
TokenType	Descreve o tipo de tokens suportados. TokenType

Funções

delay<T>(number, T)	Um wrapper para setTimeout que resolve uma promessa após t 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 { ";" Parte } [ ";" ] [ Espaço em branco ] Part ::= [ PartLiteral [ "=" PartLiteral ] ] PartLiteral ::= [ WhiteSpace ] Literal [ WhiteSpace ] Literal ::= ? qualquer sequência de caracteres, exceto ; ou = ou Espaço em Branco ? 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 dado
retry<T>(RetryConfig<T>)	Ele tentará repetir linearmente uma operação especificada número de vezes com um atraso especificado entre cada nova tentativa. As novas tentativas só acontecerão se o erro for repetido.
translate(Error \| AmqpError)	Traduz o erro 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 num navegador.
retryableErrors	Fornece uma lista de erros AMQP retentáveis. "ErrorServidorInterno", "ErrorOcupadoServidor", "Erro-ServiçoIndisponível", "ErrorOperacionalCancelado", "ErrorOcupadoEnviante", "ErrorMensagensCorredor", "DetachForçadoErro", "ErrorForçadoConexão", "LimitTransferExceededError", "ErrorTempoOperacionalSaída"

Detalhes da Função

delay<T>(number, T)

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

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

Parâmetros

t: number

O número de milissegundos a atrasar.

value: T

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

Regressos

Promise<T>

Promessa resolvida

executePromisesSequentially(any[], any)

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

Parâmetros

promiseFactories: any[]

kickstart: any

Regressos

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.

Regressos

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

Regressos

boolean

resultado - true se for um erro AMQP; false o 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.

Regressos

boolean

Booleano.

isSystemError(any)

function isSystemError(err: any): boolean

Parâmetros

err: any

Regressos

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 { ";" Parte } [ ";" ] [ Espaço em branco ] Part ::= [ PartLiteral [ "=" PartLiteral ] ] PartLiteral ::= [ WhiteSpace ] Literal [ WhiteSpace ] Literal ::= ? qualquer sequência de caracteres, exceto ; ou = ou Espaço em Branco ? 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.

Regressos

ParsedOutput<T>

ParsedOutput<T>.

randomNumberFromInterval(number, number)

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

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

Parâmetros

min: number

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

max: number

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

Regressos

number

retry<T>(RetryConfig<T>)

Ele tentará repetir linearmente uma operação especificada número de vezes com um atraso especificado entre cada nova tentativa. As novas tentativas só acontecerão se o erro for repetido.

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

Parâmetros

config: RetryConfig<T>

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

Regressos

Promise<T>

Promessa<T>.

translate(Error | AmqpError)

Traduz o erro 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.

Regressos

MessagingError

MessagingError objeto.

Variable Details

defaultLock

defaultLock: AsyncLock

Tipo

AsyncLock

isNode

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

isNode: boolean

Tipo

boolean

retryableErrors

Fornece uma lista de erros AMQP retentáveis. "ErrorServidorInterno", "ErrorOcupadoServidor", "Erro-ServiçoIndisponível", "ErrorOperacionalCancelado", "ErrorOcupadoEnviante", "ErrorMensagensCorredor", "DetachForçadoErro", "ErrorForçadoConexão", "LimitTransferExceededError", "ErrorTempoOperacionalSaída"

retryableErrors: string[]

Tipo

string[]

Comentários

Esta página foi útil?

Partilhar via

@azure/amqp-common package

Classes

Interfaces

Alias de Tipo

Enums

Funções

Variáveis

Detalhes da Função

delay<T>(number, T)

Parâmetros

Regressos

executePromisesSequentially(any[], any)

Parâmetros

Regressos

getNewAsyncLock(AsyncLockOptions)

Parâmetros

Regressos

isAmqpError(any)

Parâmetros

Regressos

isIotHubConnectionString(string)

Parâmetros

Regressos

isSystemError(any)

Parâmetros

Regressos

parseConnectionString<T>(string)

Parâmetros

Regressos

randomNumberFromInterval(number, number)

Parâmetros

Regressos

retry<T>(RetryConfig<T>)

Parâmetros

Regressos

translate(Error | AmqpError)

Parâmetros

Regressos

Variable Details

defaultLock

Tipo

isNode

Tipo

retryableErrors

Tipo

Comentários