ContextQMD
Back to Content

XMLHttpRequest: abort() method

files/en-us/web/api/xmlhttprequest/abort/index.md

latest1.5 KB
Original Source

{{APIRef("XMLHttpRequest API")}} {{AvailableInWorkers("window_and_worker_except_service")}}

The XMLHttpRequest.abort() method aborts the request if it has already been sent. When a request is aborted, its {{domxref("XMLHttpRequest.readyState", "readyState")}} is changed to XMLHttpRequest.UNSENT (0) and the request's {{domxref("XMLHttpRequest.status", "status")}} code is set to 0.

If the request is still in progress (its readyState is not XMLHttpRequest.DONE or XMLHttpRequest.UNSENT), a {{domxref("XMLHttpRequest/readystatechange_event", "readystatechange")}} event, {{domxref("XMLHttpRequestEventTarget/abort_event", "abort")}}, and a {{domxref("XMLHttpRequestEventTarget/loadend_event", "loadend")}} event are dispatched, in that order. For synchronous requests, no events are dispatched and an error is thrown instead.

Syntax

js-nolint
abort()

Parameters

None.

Return value

None ({{jsxref("undefined")}}).

Examples

This example begins loading content from the MDN home page, then due to some condition, aborts the transfer by calling abort().

js
const xhr = new XMLHttpRequest();
const method = "GET";
const url = "https://developer.mozilla.org/";
xhr.open(method, url, true);

xhr.send();

if (OH_NOES_WE_NEED_TO_CANCEL_RIGHT_NOW_OR_ELSE) {
  xhr.abort();
}

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also