AbortSignal: abort() static method

فهرست فصل‌ها دانلود آرشیوناشر

MDN Web Docs · نسخهٔ df622a2a1c1e · CC BY-SA 2.5 و مجوز جداگانهٔ ناشر برای نمونه‌کد

{{APIRef("DOM")}}{{AvailableInWorkers}}

The **AbortSignal.abort()** static method returns an {{domxref("AbortSignal")}} that is already set as aborted (and which does not trigger an {{domxref("AbortSignal/abort_event","abort")}} event).

This is shorthand for the following code:

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

This could, for example, be passed to a fetch method in order to run its abort logic (i.e., it may be that code is organized such that the abort logic should be run even if the intended fetch operation has not been started).

توجه: The method is similar in purpose to {{JSxRef("Promise.reject")}}.

Syntax

js-nolint
AbortSignal.abort()
AbortSignal.abort(reason)

Parameters

  • reason
  • : The reason why the operation was aborted, which can be any JavaScript value.

If not specified, the reason is set to "AbortError" {{domxref("DOMException")}}.

Return value

An AbortSignal instance with the {{domxref("AbortSignal.aborted")}} property set to true, and {{domxref("AbortSignal.reason")}} set to the specified or default reason value.

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}