AbortController
{{APIRef("DOM")}}
{{AvailableInWorkers}}
The AbortController
interface represents a controller object that allows you to abort one or more Web requests as and when desired.
You can create a new AbortController
object using the {{domxref("AbortController.AbortController()", "AbortController()")}}
constructor. Communicating with an asynchronous operation is done using an {{domxref("AbortSignal")}}
object.
Constructor
{{domxref("AbortController.AbortController()", "AbortController()")}}
- : Creates a new
AbortController
object instance.
- : Creates a new
Instance properties
{{domxref("AbortController.signal")}}
{{ReadOnlyInline}}
- : Returns an
{{domxref("AbortSignal")}}
object instance, which can be used to communicate with, or to abort, an asynchronous operation.
- : Returns an
Instance methods
{{domxref("AbortController.abort()")}}
- : Aborts an asynchronous operation before it has completed. This is able to abort fetch requests, consumption of any response bodies, and streams.
Examples
See the AbortSignal
page for usage examples.
You can find a full working example on GitHub; you can also see it running live.
Specifications
{{Specifications}}
Browser compatibility
{{Compat}}
See also
- Fetch API
- Abortable Fetch by Jake Archibald