AbortSignal:reason 属性

注意:此功能在Web Workers中可用。

reason 只读属性返回一个 JavaScript 值,指示中止原因。

当信号未被中止时,该属性为 undefined。可以使用 AbortController.abort()AbortSignal.abort() 在中止信号时将其设置为特定值。如果在这些方法中未显式设置,则默认为 "AbortError" DOMException

一个 JavaScript 值,指示中止原因,如果未中止,则为 undefined

示例

在下面的代码段中,我们创建了一个新的 AbortController 对象,并获取其 AbortSignal(可通过 signal 属性获取)。稍后,使用 aborted 属性,我们检查信号是否已被中止,并将中止状态和原因记录到控制台。

js
const controller = new AbortController();
const signal = controller.signal;

// …

if (signal.aborted) {
  if (signal.reason) {
    console.log(`Request aborted with reason: ${signal.reason}`);
  } else {
    console.log("Request aborted but no reason was given.");
  }
} else {
  console.log("Request not aborted");
}

规范

规范
DOM 标准
# ref-for-dom-abortsignal-reason①

浏览器兼容性

BCD 表格仅在启用 JavaScript 的浏览器中加载。

参见