你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Aborter class

  • 参考
包:
azure-maps-rest

aborter 实例实现 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 节点触发超时事件时，也会触发所有子节点的中止事件。 当超时参数 (毫秒) 大于 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 节点触发超时事件时，也会触发所有子节点的中止事件。 当超时参数 (毫秒) 大于 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