XMLHttpRequestEventTarget: loadend event
Note: This feature is available inWeb Workers, except forService Workers.
Theloadend event is fired when a request has completed, whether successfully (afterload) or unsuccessfully (afterabort orerror).
In this article
Syntax
Use the event name in methods likeaddEventListener(), or set an event handler property.
addEventListener("loadend", (event) => { })onloadend = (event) => { }Event type
AProgressEvent. Inherits fromEvent.
Event properties
In addition to the properties listed below, properties from the parent interface,Event, are available.
lengthComputableRead onlyA boolean flag indicating if the total work to be done, and the amount of work already done, by the underlying process is calculable. In other words, it tells if the progress is measurable or not.
loadedRead onlyA 64-bit unsigned integer value indicating the amount of work already performed by the underlying process. The proportion of work done can be calculated by dividing the value of this property by
total. When downloading a resource using HTTP, this only counts the body of the HTTP message, and doesn't include headers and other overhead.totalRead onlyA 64-bit unsigned integer representing the total amount of work that the underlying process is in the progress of performing. When downloading a resource using HTTP, this is the
Content-Length(the size of the body of the message), and doesn't include the headers and other overhead.
Examples
>Usage with XMLHttpRequest
HTML
<div> <input type="button" name="xhr" value="Click to start XHR (success)" /> <input type="button" name="xhr" value="Click to start XHR (error)" /> <input type="button" name="xhr" value="Click to start XHR (abort)" /></div><textarea readonly></textarea>.event-log { width: 25rem; height: 4rem; border: 1px solid black; margin: 0.5rem; padding: 0.2rem;}input { width: 11rem; margin: 0.5rem;}JavaScript
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();});Result
Usage with XMLHttpRequestUpload
You can use theloadend event to detect the (successful or not) termination of an upload. For a complete code example that uploads a file and displays a progress bar, see the mainXMLHttpRequestUpload page.
// When the upload is finished, we hide the progress bar.xhr.upload.addEventListener("loadend", (event) => { progressBar.classList.remove("visible"); if (event.loaded !== 0) { // Successful termination log.textContent = "Upload finished."; } abortButton.disabled = true;});Specifications
| Specification |
|---|
| XMLHttpRequest> # event-xhr-loadend> |
| XMLHttpRequest> # handler-xhr-onloadend> |