@azure/core-amqp package

Классы

CbsClient	Описывает клиент EventHub/ServiceBus Cbs, который взаимодействует с конечной точкой $cbs через amQP-подключение.
MessagingError	Описывает базовый класс для ошибки обмена сообщениями.
RequestResponseLink	Описывает ссылку amqp request(sender)-response(receiver), созданную в сеансе amqp.

Интерфейсы

AcquireLockProperties	Описывает свойства, которые необходимо предоставить при получении блокировки.
AmqpAnnotatedMessage	Описывает amqpAnnotatedMessage, часть свойства ServiceBusReceivedMessage(as amqpAnnotatedMessage ).
AmqpMessageHeader	Описывает определенный набор стандартных свойств заголовка сообщения.
AmqpMessageProperties	Описывает определенный набор стандартных свойств сообщения.
CancellableAsyncLock	CancellableAsyncLock предоставляет механизм для принудительного последовательного выполнения задач с использованием одного и того же ключа. Ожидающие задачи можно отменить вручную с помощью функции abortSignal или автоматически отменить, достигнув указанного значения времени ожидания.
CbsResponse	Описывает ответ CBS.
ConnectionConfig	Описывает объект конфигурации подключения, созданный после синтаксического анализа строки подключения EventHub или ServiceBus.
ConnectionConfigOptions	Описание параметров, которые можно предоставить при создании конфигурации подключения.
ConnectionContextBase	Предоставляет контекстные сведения, такие как базовое подключение amqp, сеанс cbs, tokenProvider, конфигурация подключения, преобразователь данных и т. д.
ConnectionProperties	Определяет свойства, которые необходимо задать при установке подключения AMQP.
CreateConnectionContextBaseParameters	Описывает параметры, которые можно предоставить для создания базового контекста подключения.
NetworkSystemError	Описывает поля в Node.js SystemError. Пропускает поля, не связанные с сетевыми вызовами (например, вызовы файловой системы). См. раздел https://nodejs.org/dist/latest-v12.x/docs/api/errors.html#errors_class_systemerror
RetryConfig	Описывает параметры, которые необходимо настроить для операции повтора.
RetryOptions	Параметры политики повтора, определяющие режим, количество повторных попыток, интервал повтора и т. д.
SendRequestOptions	Описывает параметры, которые можно указать при отправке запроса.
WebSocketOptions	Параметры для настройки канала подключения AMQP через веб-сокеты.

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

ParsedOutput

Определяет объект с возможными свойствами, определенными в T.

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

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

Функции

delay<T>(number, AbortSignalLike, string, T)	Оболочка для setTimeout, которая разрешает обещание после t миллисекунда.
isMessagingError(Error | MessagingError)	Определяет, является ли ошибка ошибкой MessagingError.
isSystemError(unknown)	Проверяет, является ли указанная ошибка node.js SystemError.
parseConnectionString<T>(string)	Анализирует строку подключения и возвращает объект типа T. Строки подключения имеют следующий синтаксис: ConnectionString ::= Part { ";" Part } [ ";" ] [ WhiteSpace ] Part ::= [ PartLiteral [ "=" PartLiteral ] PartLiteral ::= [ WhiteSpace ] Literal [ WhiteSpace ] Литерал ::= ? любая последовательность символов, кроме ; или = или пробел? Пробел ::= ? все символы пробелов, включая \r и \n ?
retry<T>(RetryConfig<T>)	Каждая операция выполняется по крайней мере один раз. Дополнительные попытки выполняются, если предыдущая попытка завершилась сбоем с ошибкой, допускаемой повторно. Количество дополнительных попыток определяется свойством maxRetries , указанным в аргументе RetryConfig . Если mode параметр имеет значение Fixed, повторные попытки выполняются для данной операции в течение указанного числа раз с фиксированной задержкой между каждой повторными попытками. Если mode для параметра задано значение Exponential, задержка между повторными попытками корректируется для экспоненциального увеличения при каждой попытке с использованием коэффициента отката мощности 2.
translate(unknown)	Преобразует ошибку AMQP, полученную на уровне протокола или SystemError, в MessagingError. Все остальные ошибки возвращаются без ошибок.

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

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

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

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

Параметры

delayInMs

number

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

abortSignal

AbortSignalLike

AbortSignal, связанный с содержащей операцией.

abortErrorMsg

string

Сообщение об ошибке прерывания, связанное с содержащей операцию.

value

T

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

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

Promise<T | void>

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

isMessagingError(Error | MessagingError)

Определяет, является ли ошибка ошибкой MessagingError.

function isMessagingError(error: Error | MessagingError): error

Параметры

error

Error | MessagingError

Ошибка, которая может иметь значение Error или MessagingError.

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

error

isSystemError(unknown)

Проверяет, является ли указанная ошибка node.js SystemError.

function isSystemError(err: unknown): err

Параметры

err

unknown

Объект , который может содержать сведения об ошибке.

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

err

parseConnectionString<T>(string)

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

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

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

Параметры

connectionString

string

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

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

ParsedOutput<T>

ParsedOutput.

retry<T>(RetryConfig<T>)

Каждая операция выполняется по крайней мере один раз. Дополнительные попытки выполняются, если предыдущая попытка завершилась сбоем с ошибкой, допускаемой повторно. Количество дополнительных попыток определяется свойством maxRetries , указанным в аргументе RetryConfig . Если mode параметр имеет значение Fixed, повторные попытки выполняются для данной операции в течение указанного числа раз с фиксированной задержкой между каждой повторными попытками.

Если mode для параметра задано значение Exponential, задержка между повторными попытками корректируется для экспоненциального увеличения при каждой попытке с использованием коэффициента отката мощности 2.

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

Параметры

config

RetryConfig<T>

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

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

Promise<T>

Обещаю.

translate(unknown)

Преобразует ошибку AMQP, полученную на уровне протокола или SystemError, в MessagingError. Все остальные ошибки возвращаются без ошибок.

function translate(err: unknown): MessagingError | Error

Параметры

err

unknown

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

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

MessagingError | Error

Объект MessagingError.