TaskSignal: any() статический метод

Статический метод TaskSignal.any() принимает итерируемый набор объектов AbortSignal и возвращает TaskSignal. Возвращаемый сигнал задачи завершается, когда любой из сигналов прерывания завершается.

При прерывании сигнала задачи его свойство reason будет установлено в причину первого прерванного сигнала.

signals

Итерируемый набор (например, Array) сигналов прерывания.

init Необязательный

Содержит необязательные параметры конфигурации. В настоящее время определён только один параметр:

priority Необязательный

Одно из следующих:

• Строка, являющаяся одной из user-blocking, user-visible и background.
• TaskSignal.

Экземпляр TaskSignal. Он будет прерван, когда первый переданный в signals сигнал будет прерван. В этом случае:

• Его свойство reason будет установлено в причину сигнала, который привел к прерыванию.

• Его свойство priority будет определяться параметром priority:

  • Если параметр priority был строкой, то он будет равен значению этой строки.
  • Если параметр priority был TaskSignal, он будет равен значению свойства priority этого сигнала.

Этот пример демонстрирует объединение сигнала от 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
  }
}

• AbortSignal.any()