Aborter class

パッケージ:

@azure/storage-file

Aborter インスタンスは AbortSignal インターフェイスを実装し、HTTP 要求を中止できます。

• Aborter.none を呼び出して、タイムアウトなしで新しい Aborter インスタンスを作成します。
• Aborter.timeout() を呼び出して、タイムアウトを含む新しい Aborter インスタンスを作成します。

既存のインスタンス アボートの場合:

• aborter.withTimeout() を呼び出して、タイムアウトのある子 Aborter インスタンスを作成して返します。
• aborter.withValue(key, value) を呼び出して、キーと値のペアを持つ子 Aborter インスタンスを作成して返します。
• aborter.abort() を呼び出して、現在のインスタンスとすべての子インスタンスを中止します。
• aborter.getValue(key) を呼び出して、現在のアボートからすべての親に対応するキーを使用して値を検索して取得します。

プロパティ

aborted	中止されたかどうかの状態。
none	タイムアウトなしで新しい Aborter インスタンスを作成します。
onabort	onabort イベント リスナー。

メソッド

abort()	中止イベントを直ちにトリガーすると、onabort およびすべての中止イベント リスナーがトリガーされます。 すべての子 Aborter ノードの中止イベントをトリガーしようとします。 タイムアウトがある場合、タイマーは取り消されます。 aborted が true の場合、何も起こりません。
addEventListener("abort", (this: AbortSignalLike, ev: any) => any)	新しい "abort" イベント リスナーが追加され、"abort" イベントのみがサポートされます。
dispatchEvent()
getValue(string)	[現在のノード] -> [親ノード] -> [グランド親ノード] -> ... -> [ルート ノード] のチェーンで、対応するキーを持つ最新の値を確認します。 キーが見つからない場合は、undefined が返されます。
removeEventListener("abort", (this: AbortSignalLike, ev: any) => any)	"abort" イベント リスナーを削除し、"abort" イベントのみをサポートします。
timeout(number)	タイムアウト (ミリ秒単位) の新しい Aborter インスタンスを作成します。 パラメーターのタイムアウトを 0 に設定すると、タイマーは作成されません。
withTimeout(number)	新しい Aborter インスタンスを作成して返します。このインスタンスは、現在の Aborter の子ノードとして追加されます。 現在の Aborter インスタンスは、新しいインスタンスの父ノードになります。 現在または父の Aborter ノードがタイムアウト イベントをトリガーすると、すべての子ノードの中止イベントもトリガーされます。 タイムアウト パラメーター (ミリ秒) が 0 より大きい場合、タイムアウト時に中止イベントがトリガーされます。 それ以外の場合は、abort() メソッドを呼び出して手動で中止します。
withValue(string, string | number | boolean | null)	新しい Aborter インスタンスを作成して返します。このインスタンスは、現在の Aborter の子ノードとして追加されます。 現在の Aborter インスタンスは、新しいインスタンスの父ノードになります。 現在または父の Aborter ノードがタイムアウト イベントをトリガーすると、すべての子ノードの中止イベントもトリガーされます。 変更できないキー値のペアは、新しく作成された Aborter インスタンスに設定されます。 getValue() を呼び出して、[現在のノード] -> [親ノード] と [グランド親ノード]... のチェーン内の対応するキーを持つ最新の値を見つけます。

プロパティの詳細

aborted

中止されたかどうかの状態。

aborted: boolean

プロパティ値

boolean

none

タイムアウトなしで新しい Aborter インスタンスを作成します。

static none: Aborter

プロパティ値

Aborter

onabort

onabort イベント リスナー。

onabort: (this: AbortSignalLike, ev: any) => any | null

プロパティ値

(this: AbortSignalLike, ev: any) => any | null

メソッドの詳細

abort()

中止イベントを直ちにトリガーすると、onabort およびすべての中止イベント リスナーがトリガーされます。 すべての子 Aborter ノードの中止イベントをトリガーしようとします。

• タイムアウトがある場合、タイマーは取り消されます。
• aborted が true の場合、何も起こりません。

function abort()

addEventListener("abort", (this: AbortSignalLike, ev: any) => any)

新しい "abort" イベント リスナーが追加され、"abort" イベントのみがサポートされます。

function addEventListener(_type: "abort", listener: (this: AbortSignalLike, ev: any) => any)

パラメーター

_type

"abort"

"abort" イベントのみをサポートする

listener

(this: AbortSignalLike, ev: any) => any

dispatchEvent()

function dispatchEvent()

戻り値

boolean

getValue(string)

[現在のノード] -> [親ノード] -> [グランド親ノード] -> ... -> [ルート ノード] のチェーンで、対応するキーを持つ最新の値を確認します。 キーが見つからない場合は、undefined が返されます。

function getValue(key: string)

パラメーター

key

string

戻り値

string | number | boolean | null | undefined

removeEventListener("abort", (this: AbortSignalLike, ev: any) => any)

"abort" イベント リスナーを削除し、"abort" イベントのみをサポートします。

function removeEventListener(_type: "abort", listener: (this: AbortSignalLike, ev: any) => any)

パラメーター

_type

"abort"

"abort" イベントのみをサポートする

listener

(this: AbortSignalLike, ev: any) => any

timeout(number)

タイムアウト (ミリ秒単位) の新しい Aborter インスタンスを作成します。 パラメーターのタイムアウトを 0 に設定すると、タイマーは作成されません。

static function timeout(timeout: number)

パラメーター

timeout

number

戻り値

Aborter

withTimeout(number)

新しい Aborter インスタンスを作成して返します。このインスタンスは、現在の Aborter の子ノードとして追加されます。 現在の Aborter インスタンスは、新しいインスタンスの父ノードになります。 現在または父の Aborter ノードがタイムアウト イベントをトリガーすると、すべての子ノードの中止イベントもトリガーされます。 タイムアウト パラメーター (ミリ秒) が 0 より大きい場合、タイムアウト時に中止イベントがトリガーされます。 それ以外の場合は、abort() メソッドを呼び出して手動で中止します。

function withTimeout(timeout: number)

パラメーター

timeout

number

戻り値

Aborter

新しい Aborter インスタンスが作成されました。

withValue(string, string | number | boolean | null)

新しい Aborter インスタンスを作成して返します。このインスタンスは、現在の Aborter の子ノードとして追加されます。 現在の Aborter インスタンスは、新しいインスタンスの父ノードになります。 現在または父の Aborter ノードがタイムアウト イベントをトリガーすると、すべての子ノードの中止イベントもトリガーされます。 変更できないキー値のペアは、新しく作成された Aborter インスタンスに設定されます。 getValue() を呼び出して、[現在のノード] -> [親ノード] と [グランド親ノード]... のチェーン内の対応するキーを持つ最新の値を見つけます。

function withValue(key: string, value?: string | number | boolean | null)

パラメーター

key

string

value

string | number | boolean | null

戻り値

Aborter