@azure/core-amqp package

クラス

CbsClient	AMQP 接続経由で$cbs エンドポイントと通信する EventHub/ServiceBus Cbs クライアントについて説明します。
MessagingError	メッセージング エラーの基本クラスについて説明します。
RequestResponseLink	amqp セッション経由で作成される amqp request(sender)-response(receiver) リンクについて説明します。

インターフェイス

AcquireLockProperties	ロックの取得中に指定する必要があるプロパティについて説明します。
AmqpAnnotatedMessage	ServiceBusReceivedMessage(as amqpAnnotatedMessage プロパティ) の一部である 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	Web ソケット経由の AMQP 接続のチャネリングを構成するためのオプション。

型エイリアス

ParsedOutput

T で定義できるプロパティを持つオブジェクトを定義します。

列挙型

ConditionErrorNameMapper	amqp エラー条件をエラー名にマップします。
ErrorNameConditionMapper	エラー名を amqp エラー条件にマップします。
RetryMode	再試行モードの種類について説明します
RetryOperationType	再試行操作の種類について説明します。
SystemErrorConditionMapper	一部の SystemErrors を amqp エラー状態にマップします
TokenType	サポートされているトークンの種類について説明します。

機能

delay<T>(number, AbortSignalLike, string, T)	t ミリ秒後に promise を解決する setTimeout のラッパー。
isMessagingError(Error | MessagingError)	エラーが MessagingError かどうかを判断します。
isSystemError(unknown)	指定されたエラーがnode.js SystemError であるかどうかを確認します。
parseConnectionString<T>(string)	接続文字列を解析し、T 型のオブジェクトを返します。接続文字列の構文は次のとおりです。 ConnectionString ::= Part { ";" Part } [ ";" ] [ WhiteSpace ] Part ::= [ PartLiteral [ "=" PartLiteral ] ] PartLiteral ::= [ WhiteSpace ] Literal [ WhiteSpace ] Literal ::= ? を除く任意の文字シーケンス。または = または WhiteSpace ? WhiteSpace ::= ? と \n を含むすべての\r空白文字。
retry<T>(RetryConfig<T>)	すべての操作が少なくとも 1 回試行されます。 前回の試行が再試行可能なエラーで失敗した場合は、追加の試行が行われます。 追加の試行回数は、 引数に指定RetryConfigされた maxRetries プロパティによって制御されます。 オプションが にFixed設定されている場合mode、指定した操作で再試行が指定された回数だけ行われ、各再試行の間に固定遅延が発生します。 オプションが にExponential設定されている場合mode、再試行間の遅延が指数関数的に増加するように調整され、各試行で電源 2 のバックオフ係数を使用します。
translate(unknown)	プロトコル レイヤーまたは SystemError で受信した AMQP エラーを MessagingError に変換します。 その他のすべてのエラーは変更されないまま返されます。

関数の詳細

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

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

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>

• 解決済みの Promise

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 ] Literal ::= ? を除く任意の文字シーケンス。または = または WhiteSpace ? WhiteSpace ::= ? と \n を含むすべての\r空白文字。

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

パラメーター

connectionString

string

解析する接続文字列。

戻り値

ParsedOutput<T>

ParsedOutput。

retry<T>(RetryConfig<T>)

すべての操作が少なくとも 1 回試行されます。 前回の試行が再試行可能なエラーで失敗した場合は、追加の試行が行われます。 追加の試行回数は、 引数に指定RetryConfigされた maxRetries プロパティによって制御されます。 オプションが にFixed設定されている場合mode、指定した操作で再試行が指定された回数だけ行われ、各再試行の間に固定遅延が発生します。

オプションが にExponential設定されている場合mode、再試行間の遅延が指数関数的に増加するように調整され、各試行で電源 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 オブジェクト。