XMLHttpRequest: progress Event

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 progress-Ereignis wird regelmäßig ausgelöst, wenn eine Anfrage mehr Daten erhält.

Syntax

Verwenden Sie den Ereignisnamen in Methoden wie addEventListener() oder setzen Sie eine Ereignis-Handler-Eigenschaft.

js
addEventListener("progress", (event) => {});

onprogress = (event) => {};

Ereignistyp

Ein ProgressEvent. Erbt von Event.

Event ProgressEvent

Ereigniseigenschaften

Zusätzlich zu den unten aufgelisteten Eigenschaften sind Eigenschaften der übergeordneten Schnittstelle, Event, verfügbar.

lengthComputable Schreibgeschützt

Ein boolesches Flag, das angibt, ob die gesamte zu erledigende 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-Ganzzahlwert ohne Vorzeichen, der die vom zugrunde liegenden Prozess bereits geleistete Arbeit angibt. Der Anteil der erledigten Arbeit kann berechnet werden, indem der Wert dieser Eigenschaft durch total geteilt wird. Beim Herunterladen einer Ressource über HTTP wird nur der Body der HTTP-Nachricht gezählt und nicht die Header und anderer Overhead.

total Schreibgeschützt

Ein 64-Bit-Ganzzahlwert ohne Vorzeichen, der die gesamte Arbeit darstellt, die der zugrunde liegende Prozess zu erledigen hat. Beim Herunterladen einer Ressource über HTTP entspricht dies der Content-Length (der Größe des Nachrichtenbodies) und schließt die Header und anderen Overhead nicht ein.

Beispiele

Live-Beispiel

HTML

html
<div class="controls">
  <input
    class="xhr success"
    type="button"
    name="xhr"
    value="Click to start XHR (success)" />
  <input
    class="xhr error"
    type="button"
    name="xhr"
    value="Click to start XHR (error)" />
  <input
    class="xhr abort"
    type="button"
    name="xhr"
    value="Click to start XHR (abort)" />
</div>

<textarea readonly class="event-log"></textarea>

JavaScript

js
const xhrButtonSuccess = document.querySelector(".xhr.success");
const xhrButtonError = document.querySelector(".xhr.error");
const xhrButtonAbort = document.querySelector(".xhr.abort");
const log = document.querySelector(".event-log");

function handleEvent(e) {
  log.textContent = `${log.textContent}${e.type}: ${e.loaded} bytes transferred\n`;
}

function addListeners(xhr) {
  xhr.addEventListener("loadstart", handleEvent);
  xhr.addEventListener("load", handleEvent);
  xhr.addEventListener("loadend", handleEvent);
  xhr.addEventListener("progress", handleEvent);
  xhr.addEventListener("error", handleEvent);
  xhr.addEventListener("abort", handleEvent);
}

function runXHR(url) {
  log.textContent = "";

  const xhr = new XMLHttpRequest();
  addListeners(xhr);
  xhr.open("GET", url);
  xhr.send();
  return xhr;
}

xhrButtonSuccess.addEventListener("click", () => {
  runXHR(
    "https://raw.githubusercontent.com/mdn/content/main/files/en-us/_wikihistory.json",
  );
});

xhrButtonError.addEventListener("click", () => {
  runXHR("http://i-dont-exist");
});

xhrButtonAbort.addEventListener("click", () => {
  runXHR(
    "https://raw.githubusercontent.com/mdn/content/main/files/en-us/_wikihistory.json",
  ).abort();
});

Ergebnis

Spezifikationen

Specification
XMLHttpRequest Standard
# event-xhr-progress
XMLHttpRequest Standard
# handler-xhr-onprogress

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch