XMLHttpRequestUpload: abort-Ereignis
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.
Hinweis: Diese Funktion ist in Web Workers verfügbar, mit Ausnahme von Service Workers.
Das abort
-Ereignis wird bei XMLHttpRequestUpload
ausgelöst, wenn eine Anfrage abgebrochen wurde, zum Beispiel, weil die Methode XMLHttpRequest.abort()
aufgerufen wurde.
Syntax
Verwenden Sie den Ereignisnamen in Methoden wie addEventListener()
, oder setzen Sie eine Ereignis-Handler-Eigenschaft.
addEventListener("abort", (event) => {});
onabort = (event) => {};
Ereignistyp
Ein ProgressEvent
. Erbt von Event
.
Ereigniseigenschaften
Neben den unten aufgelisteten Eigenschaften sind auch die Eigenschaften der Elternschnittstelle, Event
, verfügbar.
lengthComputable
Schreibgeschützt-
Ein boolesches Flag, das anzeigt, ob die gesamte zu leistende Arbeit und die bereits geleistete Arbeit durch den zugrunde liegenden Prozess berechenbar ist. Mit anderen Worten, es zeigt an, ob der Fortschritt messbar ist oder nicht.
loaded
Schreibgeschützt-
Ein 64-Bit-Integer-Wert, der die Menge der bereits vom zugrunde liegenden Prozess geleisteten Arbeit angibt. Das Verhältnis der geleisteten Arbeit kann berechnet werden, indem
total
durch den Wert dieser Eigenschaft geteilt wird. Beim Herunterladen einer Ressource über HTTP zählt dies nur den Körper der HTTP-Nachricht und schließt Header und anderen Overhead nicht mit ein. total
Schreibgeschützt-
Ein 64-Bit-Integer, das die Gesamtmenge der Arbeit darstellt, die der zugrunde liegende Prozess gerade verrichtet. Beim Herunterladen einer Ressource über HTTP ist dies die
Content-Length
(die Größe des Nachrichtentextes) und schließt die Header und anderen Overhead nicht mit ein.
Beispiele
Verwendung des abort
-Ereignisses
Sie können das abort
-Ereignis verwenden, um den Upload abzubrechen, bevor er abgeschlossen ist. Für ein vollständiges Codebeispiel, das eine Datei hochlädt und einen Fortschrittsbalken anzeigt, siehe die Hauptseite von XMLHttpRequestUpload
.
// In case of an abort we hide the progress bar
// Note that this event can be listened to on the xhr object too
function errorAction(event) {
progressBar.classList.remove("visible");
log.textContent = `Upload failed: ${event.type}`;
}
xhr.upload.addEventListener("abort", errorAction);
Spezifikationen
Specification |
---|
XMLHttpRequest Standard # event-xhr-abort |
XMLHttpRequest Standard # handler-xhr-onabort |
Browser-Kompatibilität
BCD tables only load in the browser