Skip to content

AbortSignal ​

AbortSignal 表示一个取消信号:有没有取消、为什么取消。把它交给 fetch() 的 signal,它一取消,请求就被取消。

AbortSignal 不能用 new 创建:new AbortSignal() 抛 TypeError: AbortSignal cannot be constructed directly, use new AbortController()。它从下面三处得到:

来源得到什么
controller.signal由 controller.abort() 控制
AbortSignal.timeout()过了指定的毫秒数自动取消
AbortSignal.abort()一个已经处于取消状态的信号

继承关系:EventTarget → AbortSignal

静态方法 ​

AbortSignal.abort()

返回一个已经取消的信号。

AbortSignal.timeout()

返回一个过了指定时间自动取消的信号。给请求设超时用它。

实例属性 ​

属性说明
aborted 只读是否已经取消
reason 只读取消的原因

实例方法 ​

还继承 EventTarget 的 addEventListener()、removeEventListener()、dispatchEvent()。

方法说明
throwIfAborted()已取消时抛出 reason

事件 ​

事件什么时候派发
abort取消时派发一次

示例 ​

js
async function main() {
  try {
    await fetch('https://httpbin.org/delay/5', { signal: AbortSignal.timeout(300) });
  } catch (err) {
    console.log(err instanceof Error ? err.name : err);
  }
}
main();

结果:300 毫秒后请求被取消,输出 AbortError。

注意:请求进行中被取消时,fetch() 和 read() 抛出的不是 signal.reason,而是一个新的 AbortError。所以 AbortSignal.timeout() 到时间后 signal.reason.name 是 'TimeoutError',fetch() 抛出的异常的 name 是 'AbortError'。判断请求是否被取消,看异常的 name 是不是 'AbortError'。

和 Web 的差别 ​

  • 没有 DOMException。默认的 reason 是 name 为 'AbortError' 的 Error,超时的 reason 是 name 为 'TimeoutError' 的 Error。
  • 请求进行中被取消时,fetch() 抛出 AbortError,不是 signal.reason。
  • 没有 AbortSignal.any(),没有 onabort 属性。

参见 ​