@azure/core-amqp package

參考

類別

CbsClient	描述透過AMQP連線與$cbs端點交談的 EventHub/ServiceBus Cbs 用戶端。
MessagingError	描述傳訊錯誤的基類。
RequestResponseLink	描述透過amqp會話建立的amqp要求（sender）-response（receiver）連結。

介面

AcquireLockProperties	描述取得鎖定時必須提供的屬性。
AmqpAnnotatedMessage	描述 AmqpAnnotatedMessage，這是 ServiceBusReceivedMessage 的一部分（如 `amqpAnnotatedMessage` 屬性）。
AmqpMessageHeader	描述訊息的已定義標準標頭屬性集。
AmqpMessageProperties	描述訊息的已定義標準屬性集。
CancellableAsyncLock	CancellableAsyncLock 提供一種機制，可強制使用相同 'key' 以序列方式執行的工作。暫止的工作可以透過中止手動取消，或透過達到提供的逾時值自動取消。
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	透過 Web 套接字設定 AMQP 連線通道的選項。

類型別名

ParsedOutput

使用 T 中定義的可能屬性來定義物件。

列舉

ConditionErrorNameMapper	將amqp錯誤條件對應至錯誤名稱。
ErrorNameConditionMapper	將錯誤名稱對應至amqp錯誤條件。
RetryMode	描述重試模式類型
RetryOperationType	描述重試作業類型。
SystemErrorConditionMapper	將某些 SystemErrors 對應至 amqp 錯誤狀況
TokenType	描述支援的令牌類型。

函式

delay<T>(number, AbortSignalLike, string, T)	setTimeout 的包裝函式，會在 t 毫秒之後解析承諾。
isMessagingError(MessagingError \| Error)	判斷錯誤是否為 MessagingError。
isSystemError(unknown)	檢查所提供的錯誤是否為 node.js SystemError。
parseConnectionString<T>(string)	剖析連接字串，並傳回 T 類型的物件。連接字串具有下列語法： ConnectionString ：：= `Part { ";" Part } [ ";" ] [ WhiteSpace ]` Part ：：= [ PartLiteral [ “=” PartLiteral ] ] PartLiteral ：：= [ WhiteSpace ] Literal [ WhiteSpace ] Literal ：：= ？除了以外的任何字元序列;或 = 或 WhiteSpace ？ WhiteSpace ：：= ？所有空格符，包括 `\r` 和 `\n`？
retry<T>(RetryConfig<T>)	每次作業至少嘗試一次。如果先前的嘗試失敗並出現可重試的錯誤，則會進行其他嘗試。其他嘗試的數目是由 `RetryConfig` 自變數上提供的 `maxRetries` 屬性所控管。如果 `mode` 選項設定為 `Fixed`，則會在指定的作業上重試指定次數，每次重試之間都會有固定的延遲。如果 `mode` 選項設定為 `Exponential`，則會調整重試之間的延遲，以使用電源 2 的倒退因數，以指數方式增加。
translate(unknown)	將通訊協定層或 SystemError 收到的 AMQP 錯誤轉譯為 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(MessagingError | Error)

判斷錯誤是否為 MessagingError。

function isMessagingError(error: MessagingError | Error): error

參數

error: MessagingError | Error

可以是 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 ] Literal ：：= ？除了以外的任何字元序列;或 = 或 WhiteSpace ？ WhiteSpace ：：= ？所有空格符，包括 \r 和 \n？

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

參數

connectionString: string

要剖析的連接字串。

傳回

ParsedOutput<T>

ParsedOutput。

retry<T>(RetryConfig<T>)

每次作業至少嘗試一次。如果先前的嘗試失敗並出現可重試的錯誤，則會進行其他嘗試。其他嘗試的數目是由 RetryConfig 自變數上提供的 maxRetries 屬性所控管。

如果 mode 選項設定為 Fixed，則會在指定的作業上重試指定次數，每次重試之間都會有固定的延遲。

如果 mode 選項設定為 Exponential，則會調整重試之間的延遲，以使用電源 2 的倒退因數，以指數方式增加。

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

參數

config: RetryConfig<T>

設定重試作業的參數

傳回

Promise<T>

承諾。

translate(unknown)

將通訊協定層或 SystemError 收到的 AMQP 錯誤轉譯為 MessagingError。所有其他錯誤都會傳回不變。

function translate(err: unknown): MessagingError | Error

參數

err: unknown

收到的amqp錯誤。

傳回

MessagingError | Error

MessagingError 物件。

共用方式為