TaskSignal: any() 静态方法

实验性： 这是一个实验性技术
在生产环境中使用之前，请仔细查看浏览器兼容性表格。

TaskSignal.any() 静态方法接收一个 AbortSignal 对象的可迭代对象，并返回一个 TaskSignal。当任何一个中止信号被中止时，返回的任务信号将被中止。

当任务信号被中止时，其 reason 属性将被设置为第一个被中止的信号的原因。

语法

TaskSignal.any(signals)
TaskSignal.any(signals, init)

参数

signals

一个可迭代对象（例如 Array）的中止信号。

init 可选

包含可选的配置参数。目前仅定义了一个属性

priority 可选

以下之一

一个字符串，其值为 user-blocking、user-visible 和 background 之一。
一个 TaskSignal。

返回值

一个 TaskSignal 实例。当传递给 signals 的第一个信号被中止时，它将被中止。发生这种情况时

其 reason 属性将设置为导致该信号中止的信号的原因。
其 priority 属性将由 priority 参数确定
- 如果 priority 参数是一个字符串，它将是字符串的值。
- 如果 priority 参数是一个 TaskSignal，它将是该信号的 priority 值。

示例

使用 `TaskSignal.any()`

此示例演示了如何结合来自 TaskController 的信号和来自 TaskSignal.timeout() 的超时信号。

const cancelDownloadButton = document.getElementById("cancelDownloadButton");

const userCancelController = new TaskController({
  priority: "user-visible",
});

cancelDownloadButton.addEventListener("click", () => {
  userCancelController.abort();
});

// Timeout after 5 minutes
const timeoutSignal = TaskSignal.timeout(1_000 * 60 * 5);

// This signal will abort when either the user clicks the cancel button or 5 minutes is up whichever is sooner
const combinedSignal = TaskSignal.any([
  userCancelController.signal,
  timeoutSignal,
]);

try {
  const res = await fetch(someUrlToDownload, {
    // Stop the fetch when any of the
    signal: combinedSignal,
  });
  const body = await res.blob();
  // Do something with downloaded content
  // ...
} catch (e) {
  if (e.name === "AbortError") {
    // Cancelled by the user
  } else if (e.name === "TimeoutError") {
    // Show user that download timed out
  } else {
    // Other error, e.g. network error
  }
}

规范

规范
优先级任务调度 # dom-tasksignal-any

浏览器兼容性

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

另请参阅

AbortSignal.any()