共用方式為

Aborter class

  • 參考
套件:
azure-maps-rest

中止實例會實作 AbortSignal 介面，可以中止 HTTP 要求。

  • 呼叫 Aborter.none 以在不逾時的情況下建立新的 Aborter 實例。
  • 呼叫 Aborter.timeout () ，以建立具有逾時的新 Aborter 實例。

針對現有的實例中止器：

  • 呼叫 aborter.withTimeout () ，以建立並傳回具有逾時的子 Aborter 實例。
  • 呼叫 aborter.withValue (索引鍵、值) ，以建立並傳回具有索引鍵/值組的子 Aborter 實例。
  • 呼叫aborter.abort () 中止目前的實例和所有子實例。
  • 呼叫 aborter.getValue (索引鍵) ，以從目前中止器到所有父系的對應索引鍵來搜尋和取得值。

屬性

aborted

是否中止的狀態。
none

建立新的 Aborter 實例而不逾時。
onabort

onabort 事件接聽程式。

方法

abort()

立即觸發中止事件，將會觸發 onabort 和所有中止事件接聽程式。 將會嘗試觸發所有子系 Aborter 節點的中止事件。

  • 如果有逾時，定時器將會取消。
  • 如果中止為 true，則不會發生任何動作。
addEventListener("abort", (this: AbortSignalLike, ev: any) => any)

已新增 「中止」事件接聽程式，僅支援「中止」事件。
getValue(string)

在 [目前節點] - [父節點] - [父節點] -> ... ->> [根節點>] 的鏈結中，找出具有對應索引鍵的最新值。 如果找不到索引鍵，則會傳回未定義的 。
removeEventListener("abort", (this: AbortSignalLike, ev: any) => any)

拿掉 「中止」事件接聽程式，僅支援「中止」事件。
timeout(number)

建立新的 Aborter 實例，其逾時以毫秒為單位。 將參數逾時設定為 0 將不會建立定時器。
withTimeout(number)

建立並傳回新的 Aborter 實例，此實例會附加為目前 Aborter 的子節點。 目前的 Aborter 實例會變成新實例的父節點。 當目前或父 Aborter 節點觸發逾時事件時，也會觸發所有子節點的中止事件。 當 timeout 參數 (毫秒) 大於 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?: (ev?: Event) => any

屬性值

(ev?: Event) => any

方法詳細資料

abort()

立即觸發中止事件，將會觸發 onabort 和所有中止事件接聽程式。 將會嘗試觸發所有子系 Aborter 節點的中止事件。

  • 如果有逾時，定時器將會取消。
  • 如果中止為 true，則不會發生任何動作。
function abort()

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

已新增 「中止」事件接聽程式，僅支援「中止」事件。

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

參數

_type

"abort"

僅支援「中止」事件

listener

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

getValue(string)

在 [目前節點] - [父節點] - [父節點] -> ... ->> [根節點>] 的鏈結中，找出具有對應索引鍵的最新值。 如果找不到索引鍵，則會傳回未定義的 。

function getValue(key: string): string | number | boolean | null | undefined

參數

key

string

傳回

string | number | boolean | null | undefined

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

拿掉 「中止」事件接聽程式，僅支援「中止」事件。

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

參數

_type

"abort"

僅支援「中止」事件

listener

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

timeout(number)

建立新的 Aborter 實例，其逾時以毫秒為單位。 將參數逾時設定為 0 將不會建立定時器。

static function timeout(timeout: number): Aborter

參數

timeout

number

傳回

Aborter

withTimeout(number)

建立並傳回新的 Aborter 實例，此實例會附加為目前 Aborter 的子節點。 目前的 Aborter 實例會變成新實例的父節點。 當目前或父 Aborter 節點觸發逾時事件時，也會觸發所有子節點的中止事件。 當 timeout 參數 (毫秒) 大於 0 時，會在逾時時觸發中止事件。 否則，請呼叫 abort () 方法來手動中止。

function withTimeout(timeout: number): Aborter

參數

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): Aborter

參數

key

string

value

string | number | boolean | null

傳回

Aborter