XMLHttpRequest: abort() メソッド
Baseline
広く利用可能
この機能は広く実装されており、多くのバージョンの端末やブラウザーで動作します。2015年7月以降、すべてのブラウザーで利用可能です。
XMLHttpRequest.abort() メソッドは、すでに送信されたリクエストを中止します。リクエストが中止されたら、 readyState が XMLHttpRequest.UNSENT (0) に変化し、リクエストの status コードが 0 に設定されます。
リクエストがまだ進行中である場合(その readyState が XMLHttpRequest.DONE または XMLHttpRequest.UNSENT でない場合)、 readystatechange イベントと、abort、そして loadend イベントが、この順序で配信されます。同期リクエストの場合、イベントは配信されず、代わりにエラーが発生します。
構文
js
abort()
引数
なし。
返値
なし (undefined)。
例
この例では、 MDN のホームページからコンテンツを読み込み始め、ある条件が発生したときに、 abort() を呼び出すことで転送を中止します。
js
const xhr = new XMLHttpRequest();
const method = "GET";
const url = "https://mdn.go-mizu.dev/";
xhr.open(method, url, true);
xhr.send();
if (OH_NOES_WE_NEED_TO_CANCEL_RIGHT_NOW_OR_ELSE) {
xhr.abort();
}
仕様書
| 仕様書 |
|---|
| XMLHttpRequest> # the-abort()-method> |