@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 request(sender)-response(receiver) リンクについて説明します。
SasTokenProvider
Timeout	指定した時間待機し、指定された値で Promise を解決または拒否できる 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)	t ミリ秒後に promise を解決する setTimeout のラッパー。
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 ? ホワイトスペース ::= ? \r や \n を含むすべての空白文字?
randomNumberFromInterval(number, number)	指定された間隔の間に乱数を生成します。
retry<T>(RetryConfig<T>)	各再試行の間に指定された遅延で、指定された回数だけ操作を線形的に再試行しようとします。 再試行は、エラーが再試行可能な場合にのみ発生します。
translate(Error | AmqpError)	プロトコル 層で受信した AQMP エラーまたは汎用エラーを MessagingError に変換します。

変数

defaultLock
isNode	環境が node.js かブラウザベースかを示す定数です。
retryableErrors	再試行可能なAMQPエラーのリストを提供します。 「InternalServerError」「ServerBusyError」「ServiceUnavailableError」「OperationCancelledError」「SenderBusyError」「MessagingError」「DetachForcedError」「ConnectionForcedError」「TransferLimitExceededError」「OperationTimeoutError」

関数の詳細

delay<T>(number, T)

t ミリ秒後に promise を解決する setTimeout のラッパー。

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

パラメーター

t

number

遅延するミリ秒数。

value

T

タイムアウト後に解決される値 (ミリ秒)。

戻り値

Promise<T>

• 解決済みの Promise

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 ? ホワイトスペース ::= ? \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エラーのリストを提供します。 「InternalServerError」「ServerBusyError」「ServiceUnavailableError」「OperationCancelledError」「SenderBusyError」「MessagingError」「DetachForcedError」「ConnectionForcedError」「TransferLimitExceededError」「OperationTimeoutError」

retryableErrors: string[]

型

string[]