@azure/amqp-common package

Классы

AsyncLock
AadTokenProvider	Определяет AAD (Azure ActiveDirectory) TokenProvider. При этом будут приняты следующие учетные @azure/ms-rest-nodeauth данные из пакета: ApplicationTokenCredentials UserTokenCredentials DeviceTokenCredentials MSITokenCredentials (MSIVmTokenCredentials)
CbsClient
DefaultDataTransformer	Преобразователь данных по умолчанию, который будет использоваться пакетом AZURE SDK.
MessagingError	Описывает базовый класс для ошибки обмена сообщениями.
RequestResponseLink	Описывает ссылку amqp request(sender)-response(receiver), созданную в сеансе amqp.
SasTokenProvider
Timeout	Описывает класс Timeout, который может ожидать указанное время, а затем разрешить или отклонить обещание с заданным значением.

Интерфейсы

AsyncLockOptions
ConnectionConfig	Описывает объект конфигурации подключения, созданный после синтаксического анализа строки подключения EventHub или ServiceBus.
ConnectionContextBase
EventHubConnectionConfig	Описывает объект конфигурации подключения, созданный после синтаксического анализа строки подключения Концентратора событий. Он также предоставляет некоторые удобные методы для получения адреса и аудитории для различных сущностей.
MessageHeader	Описывает определенный набор стандартных свойств заголовка сообщения.
MessageProperties	Описывает определенный набор стандартных свойств сообщения.
AmqpMessage	Описывает сообщение AMQP, отправленное или полученное по сети.
AmqpMessageHeader	Описывает определенный набор стандартных свойств заголовка сообщения.
AmqpMessageProperties	Описывает определенный набор стандартных свойств сообщения.
AsyncLockOptions	Описание параметров, которые можно предоставить для создания асинхронной блокировки.
CbsResponse	Описывает ответ CBS.
ConnectionConfigOptions	Описание параметров, которые можно предоставить при создании конфигурации подключения.
ConnectionProperties	Определяет свойства, которые необходимо задать при установке подключения AMQP.
CreateConnectionContextBaseParameters	Описывает параметры, которые можно предоставить для создания базового контекста подключения.
DataTransformer	Описывает преобразования, которые можно выполнить для кодирования и декодирования данных перед их отправкой по сети (или получением из нее).
Dictionary	Предоставляет словарь, например ключ структуры <, значение> типа T.
EventHubConnectionStringModel	Описывает модель строки подключения концентратора событий.
IotHubConnectionStringModel	Описывает модель строки подключения iothub.
RetryConfig	Описывает параметры, которые необходимо настроить для операции повтора.
SendRequestOptions	Описывает параметры, которые можно указать при отправке запроса.
ServiceBusConnectionStringModel	Описывает модель строки подключения служебной шины.
StorageConnectionStringModel	Описывает модель строки подключения stroage.
TokenInfo	Предоставляет сведения о маркере.
TokenProvider	Описывает базовый поставщик маркеров.

Псевдонимы типа

AsyncLockDoneCallback
Func	Объявление типа для типа функции, где T — входные данные функции, а V — выходные данные функции.
ParsedOutput	Определяет объект с возможными свойствами, определенными в T.

Перечисления

ConditionErrorNameMapper	Сопоставляет условия ошибок amqp с именами ошибок.
ConditionStatusMapper	Сопоставляет условия с числовыми кодами состояния ответа AMQP.
ErrorNameConditionMapper	Сопоставляет имена ошибок с условиями ошибок amqp.
RetryOperationType	Описывает тип операции повтора. RetryOperationType
SystemErrorConditionMapper	Сопоставляет некоторые SytemErrors с условиями ошибок amqp SystemErrorConditionMapper
TokenType	Описывает тип поддерживаемых маркеров. TokenType

Функции

delay<T>(number, T)	Оболочка для setTimeout, которая разрешает обещание после t миллисекунда.
executePromisesSequentially(any[], any)
getNewAsyncLock(AsyncLockOptions)	Возвращает новый экземпляр асинхронной блокировки с нужными параметрами.
isAmqpError(any)	Определяет, похож ли данный объект ошибки на объект AmqpError.
isIotHubConnectionString(string)	Определяет, является ли указанная строка подключения строкой подключения iothub.
isSystemError(any)
parseConnectionString<T>(string)	Анализирует строку подключения и возвращает объект типа T. Строки подключения имеют следующий синтаксис: ConnectionString ::= Part { ";" Часть } [ ";" ] [ Пробел ] Part ::= [ PartLiteral [ "=" PartLiteral ] PartLiteral ::= [ WhiteSpace ] Литерал [ WhiteSpace ] Литерал ::= ? любая последовательность символов, кроме ; или = или пробел? Пробел ::= ? все символы пробелов, включая \r и \n ?
randomNumberFromInterval(number, number)	Создает случайное число между заданным интервалом.
retry<T>(RetryConfig<T>)	Он будет пытаться линейно повторять операцию указанное количество раз с указанной задержкой между каждой повторными попытками. Повторные попытки будут выполняться только в том случае, если ошибка может быть повторна.
translate(Error | AmqpError)	Преобразует ошибку AQMP, полученную на уровне протокола, или универсальную ошибку в MessagingError.

Сведения о функции

delay<T>(number, T)

Оболочка для setTimeout, которая разрешает обещание после t миллисекунда.

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

Параметры

t

number

Число миллисекундах для задержки.

value

T

Значение, с которым необходимо разрешить по истечении времени ожидания t миллисекунда.

Возвращаемое значение

Promise<T>

• Обещание решено

executePromisesSequentially(any[], any)

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

Параметры

promiseFactories

any[]

kickstart

any

Возвращаемое значение

Promise<any>

getNewAsyncLock(AsyncLockOptions)

Возвращает новый экземпляр асинхронной блокировки с нужными параметрами.

function getNewAsyncLock(options?: AsyncLockOptions): AsyncLock

Параметры

options

AsyncLockOptions

Параметры асинхронной блокировки.

Возвращаемое значение

AsyncLock

AsyncLock

isAmqpError(any)

Определяет, похож ли данный объект ошибки на объект AmqpError.

function isAmqpError(err: any): boolean

Параметры

err

any

Объект AmqpError

Возвращаемое значение

boolean

result — true значение , если это ошибка AMQP; false в противном случае — значение .

isIotHubConnectionString(string)

Определяет, является ли указанная строка подключения строкой подключения iothub.

function isIotHubConnectionString(connectionString: string): boolean

Параметры

connectionString

string

Строка подключения.

Возвращаемое значение

boolean

логическое

isSystemError(any)

function isSystemError(err: any): boolean

Параметры

err

any

Возвращаемое значение

boolean

parseConnectionString<T>(string)

Анализирует строку подключения и возвращает объект типа T.

Строки подключения имеют следующий синтаксис:

ConnectionString ::= Part { ";" Часть } [ ";" ] [ Пробел ] Part ::= [ PartLiteral [ "=" PartLiteral ] PartLiteral ::= [ WhiteSpace ] Литерал [ WhiteSpace ] Литерал ::= ? любая последовательность символов, кроме ; или = или пробел? Пробел ::= ? все символы пробелов, включая \r и \n ?

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

Параметры

connectionString

string

Строка подключения для анализа.

Возвращаемое значение

ParsedOutput<T>

ParsedOutput.

randomNumberFromInterval(number, number)

Создает случайное число между заданным интервалом.

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

Параметры

min

number

Минимальное число диапазона (включительно).

max

number

Максимальное число диапазона (включительно).

Возвращаемое значение

number

retry<T>(RetryConfig<T>)

Он будет пытаться линейно повторять операцию указанное количество раз с указанной задержкой между каждой повторными попытками. Повторные попытки будут выполняться только в том случае, если ошибка может быть повторна.

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

Параметры

config

RetryConfig<T>

Параметры для настройки операции повтора.

Возвращаемое значение

Promise<T>

Обещаю.

translate(Error | AmqpError)

Преобразует ошибку AQMP, полученную на уровне протокола, или универсальную ошибку в MessagingError.

function translate(err: Error | AmqpError): MessagingError

Параметры

err

Error | AmqpError

Полученная ошибка amqp.

Возвращаемое значение

MessagingError

Объект MessagingError.