@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會話建立的amqp要求（sender）-response（receiver） 連結。
SasTokenProvider
Timeout	描述逾時類別，該類別可以等候指定的時間量，然後使用指定的值解析/拒絕承諾。

介面

AsyncLockOptions
ConnectionConfig	描述剖析 EventHub 或 ServiceBus 連接字串之後所建立的連接組態物件。
ConnectionContextBase
EventHubConnectionConfig	描述剖析 EventHub 連接字串之後所建立的連接組態物件。 它也提供一些方便的方法，以取得不同實體的地址和物件。
MessageHeader	描述訊息的已定義標準標頭屬性集。
MessageProperties	描述訊息的已定義標準屬性集。
AmqpMessage	描述在線路上傳送或接收的AMQP訊息。
AmqpMessageHeader	描述訊息的已定義標準標頭屬性集。
AmqpMessageProperties	描述訊息的已定義標準屬性集。
AsyncLockOptions	描述可用來建立異步鎖定的選項。
CbsResponse	描述 CBS 回應。
ConnectionConfigOptions	描述可在建立連線設定時提供的選項。
ConnectionProperties	定義建立AMQP連線時需要設定的屬性。
CreateConnectionContextBaseParameters	描述可用來建立基底連接內容的參數。
DataTransformer	描述可以在傳送數據之前，先對數據進行編碼/譯碼的轉換（或從該網路接收數據）。
Dictionary	提供字典，例如類型 T 的結構 <索引鍵、值>。
EventHubConnectionStringModel	描述 eventhub 連接字串模型。
IotHubConnectionStringModel	描述 iothub 連接字串模型。
RetryConfig	描述必須針對重試作業設定的參數。
SendRequestOptions	描述傳送要求時可指定的選項。
ServiceBusConnectionStringModel	描述 servicebus 連接字串模型。
StorageConnectionStringModel	描述簡介連接字串模型。
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 } [ “;” ][ WhiteSpace ]Part ：：= [ PartLiteral [ “=” PartLiteral ] ] PartLiteral ：：= [ WhiteSpace ] Literal [ WhiteSpace ] Literal ：：= ？ 除了以外的任何字元序列;或 = 或 WhiteSpace ？ WhiteSpace ：：= ？ 所有空格符，包括 \r 和 \n？
randomNumberFromInterval(number, number)	在指定的間隔之間產生隨機數
retry<T>(RetryConfig<T>)	它會嘗試在每次重試之間以指定的延遲，以線性方式重試指定的作業次數。 只有在錯誤可重試時才會發生重試。
translate(Error | AmqpError)	將通訊協定層收到的 AQMP 錯誤或一般錯誤轉譯為 MessagingError。

變數

defaultLock
isNode	一個常數，用來判斷環境是 node.js 還是瀏覽器。
retryableErrors	提供可重試的 AMQP 錯誤清單。 「內部伺服器錯誤」、「ServerBusyError」、「ServiceUnavailableError」、「操作取消錯誤」、「SenderBusyError」、「訊息錯誤」、「DetachForcedError」、「連線強制錯誤」、「傳輸限制超額錯誤」、「操作逾時錯誤」

函式詳細資料

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 - 如果它是AMQP錯誤，true;否則 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 } [ “;” ][ 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<T>。

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>

承諾<T>.

translate(Error | AmqpError)

將通訊協定層收到的 AQMP 錯誤或一般錯誤轉譯為 MessagingError。

function translate(err: Error | AmqpError): MessagingError

參數

err

Error | AmqpError

收到的amqp錯誤。

傳回

MessagingError

MessagingError 物件。

Variable Details

defaultLock

defaultLock: AsyncLock

類型

AsyncLock

isNode

一個常數，用來判斷環境是 node.js 還是瀏覽器。

isNode: boolean

類型

boolean

retryableErrors

提供可重試的 AMQP 錯誤清單。 「內部伺服器錯誤」、「ServerBusyError」、「ServiceUnavailableError」、「操作取消錯誤」、「SenderBusyError」、「訊息錯誤」、「DetachForcedError」、「連線強制錯誤」、「傳輸限制超額錯誤」、「操作逾時錯誤」

retryableErrors: string[]

類型

string[]