XMLHttpRequestUpload: timeout event
The timeout
event is fired when progression is terminated due to preset time expiring.
Syntax
Use the event name in methods like addEventListener()
, or set an event handler property.
js
addEventListener("timeout", (event) => {});
ontimeout = (event) => {};
Event type
A ProgressEvent
. Inherits from Event
.
Event properties
In addition to the properties listed below, properties from the parent interface, Event
, are available.
lengthComputable
Read only-
A 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.
loaded
Read only-
A 64-bit unsigned integer value indicating the amount of work already performed by the underlying process. The ratio of work done can be calculated by dividing
total
by the value of this property. When downloading a resource using HTTP, this only counts the body of the HTTP message, and doesn't include headers and other overhead. total
Read only-
A 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
Using the timeout
event
You can use the timeout
event to detect an upload that stopped because it was too slow. For a complete code example that uploads a file and displays a progress bar, see the main XMLHttpRequestUpload
page.
The timeout is set on the XMLHttpRequest
object using the XMLHttpRequest.timeout
property.
js
// In case of an timeout 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("timeout", errorAction);
Specifications
Specification |
---|
XMLHttpRequest Standard # event-xhr-timeout |
XMLHttpRequest Standard # handler-xhr-ontimeout |
Browser compatibility
BCD tables only load in the browser
See also
- Related events:
loadstart
,load
,progress
,error
,loadend
,abort
XMLHttpRequestUpload
XMLHttpRequest.timeout