Aborter class
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 とすべての abort イベント リスナーがトリガーされます。 すべての子 Aborter ノードに対して abort イベントをトリガーしようとします。
|
add |
新しい "abort" イベント リスナーが追加され、"abort" イベントのみがサポートされました。 |
get |
[現在のノード] - [親ノード] - [グランド親ノード] -> ...> -> [ルート ノード>] のチェーンで、対応するキーを持つ最新の値を確認します。 キーが見つからない場合は、undefined が返されます。 |
remove |
"abort" イベント リスナーを削除し、"abort" イベントのみをサポートします。 |
timeout(number) | タイムアウト (ミリ秒単位) の新しい Aborter インスタンスを作成します。 パラメーターのタイムアウトを 0 に設定すると、タイマーは作成されません。 |
with |
新しい Aborter インスタンスを作成して返します。このインスタンスは、現在の Aborter の子ノードとして追加されます。 現在の Aborter インスタンスは、新しいインスタンスの親ノードになります。 現在または親の Aborter ノードがタイムアウト イベントをトリガーすると、すべての子ノードの abort イベントもトリガーされます。 timeout パラメーター (ミリ秒単位) が 0 より大きい場合、タイムアウト時に中止イベントがトリガーされます。 それ以外の場合は、abort() メソッドを呼び出して手動で中止します。 |
with |
新しい Aborter インスタンスを作成して返します。このインスタンスは、現在の Aborter の子ノードとして追加されます。 現在の Aborter インスタンスは、新しいインスタンスの親ノードになります。 現在または親の Aborter ノードがタイムアウト イベントをトリガーすると、すべての子ノードの abort イベントもトリガーされます。 変更できないキー値のペアは、新しく作成された Aborter インスタンスに設定されます。 getValue() を呼び出して、[現在のノード] -> [親ノード] と [グランド親ノード]...のチェーン内の対応するキーを持つ最新の値を確認します。 |
プロパティの詳細
aborted
中止されたかどうかの状態。
aborted: boolean
プロパティ値
boolean
none
onabort
onabort イベント リスナー。
onabort?: (ev?: Event) => any
プロパティ値
(ev?: Event) => any
メソッドの詳細
abort()
中止イベントを直ちにトリガーすると、onabort とすべての abort イベント リスナーがトリガーされます。 すべての子 Aborter ノードに対して abort イベントをトリガーしようとします。
- タイムアウトが発生した場合、タイマーは取り消されます。
- 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
getValue(string)
[現在のノード] - [親ノード] - [グランド親ノード] -> ...> -> [ルート ノード>] のチェーンで、対応するキーを持つ最新の値を確認します。 キーが見つからない場合は、undefined が返されます。
function getValue(key: string): string | number | boolean | null | undefined
パラメーター
- 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): Aborter
パラメーター
- timeout
-
number
戻り値
withTimeout(number)
新しい Aborter インスタンスを作成して返します。このインスタンスは、現在の Aborter の子ノードとして追加されます。 現在の Aborter インスタンスは、新しいインスタンスの親ノードになります。 現在または親の Aborter ノードがタイムアウト イベントをトリガーすると、すべての子ノードの abort イベントもトリガーされます。 timeout パラメーター (ミリ秒単位) が 0 より大きい場合、タイムアウト時に中止イベントがトリガーされます。 それ以外の場合は、abort() メソッドを呼び出して手動で中止します。
function withTimeout(timeout: number): Aborter
パラメーター
- timeout
-
number
戻り値
新しい Aborter インスタンスが作成されました。
withValue(string, string | number | boolean | null)
新しい Aborter インスタンスを作成して返します。このインスタンスは、現在の Aborter の子ノードとして追加されます。 現在の Aborter インスタンスは、新しいインスタンスの親ノードになります。 現在または親の Aborter ノードがタイムアウト イベントをトリガーすると、すべての子ノードの abort イベントもトリガーされます。 変更できないキー値のペアは、新しく作成された Aborter インスタンスに設定されます。 getValue() を呼び出して、[現在のノード] -> [親ノード] と [グランド親ノード]...のチェーン内の対応するキーを持つ最新の値を確認します。
function withValue(key: string, value?: string | number | boolean | null): Aborter
パラメーター
- key
-
string
- value
-
string | number | boolean | null