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 das Programm XMLHttpRequest.abort()
aufgerufen hat.
Syntax
Verwenden Sie den Ereignisnamen in Methoden wie addEventListener()
oder setzen Sie eine Event-Handler-Eigenschaft.
addEventListener("abort", (event) => { })
onabort = (event) => { }
Ereignistyp
Ein ProgressEvent
. Erbt von Event
.
Ereigniseigenschaften
Zusätzlich zu den unten aufgeführten Eigenschaften sind Eigenschaften der Elternschnittstelle, Event
, verfügbar.
lengthComputable
Schreibgeschützt-
Eine boolesche Kennzeichnung, die angibt, ob die gesamte zu leistende Arbeit und die bereits geleistete Arbeit des zugrunde liegenden Prozesses berechenbar sind. Mit anderen Worten, es zeigt an, ob der Fortschritt messbar ist oder nicht.
loaded
Schreibgeschützt-
Ein 64-Bit-Unsigned-Integer-Wert, der die bereits vom zugrunde liegenden Prozess geleistete Arbeit angibt. Das Verhältnis der erledigten Arbeit kann berechnet werden, indem
total
durch den Wert dieser Eigenschaft geteilt wird. Beim Herunterladen einer Ressource über HTTP zählt dies nur den Hauptteil der HTTP-Nachricht und schließt Header und anderen Overhead nicht ein. total
Schreibgeschützt-
Ein 64-Bit-Unsigned-Integer, der die Gesamtmenge der Arbeit darstellt, die der zugrunde liegende Prozess dabei ist auszuführen. Beim Herunterladen einer Ressource über HTTP ist dies die
Content-Length
(die Größe des Hauptteils der Nachricht) und schließt die Header und anderen Overhead nicht ein.
Beispiele
Verwendung des abort
-Ereignisses
Sie können das abort
-Ereignis verwenden, um den Upload zu stoppen, bevor er abgeschlossen ist. Für ein vollständiges Codebeispiel, das eine Datei hochlädt und eine Fortschrittsleiste anzeigt, siehe die Hauptseite 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 # event-xhr-abort |
XMLHttpRequest # handler-xhr-onabort |