HTMLImageElement: decode() method
The decode()
method of the HTMLImageElement
interface returns a
Promise
that resolves when the image is decoded and it is safe to append
the image to the DOM.
This can be used to initiate loading of the image prior to attaching it to an element in the DOM (or adding it to the DOM as a new element), so that the image can be rendered immediately upon being added to the DOM. This, in turn, prevents the rendering of the next frame after adding the image to the DOM from causing a delay while the image loads.
Syntax
js
decode()
Parameters
None.
Return value
A Promise
which is resolved once the image data is ready to be used.
Exceptions
EncodingError
-
A
DOMException
indicating that an error occurred while decoding the image.
Usage notes
One potential use case for decode()
: when loading very large images (for
example, in an online photo album), you can present a low resolution thumbnail image
initially and then replace that image with the full-resolution image by instantiating a
new HTMLImageElement
, setting its source to the full-resolution image's
URL, then using decode()
to get a promise which is resolved once the
full-resolution image is ready for use. At that time, you can then replace the
low-resolution image with the full-resolution one that's now available.
Examples
The following example shows how to use the decode()
method to control when
an image is appended to the DOM. Without a Promise
-returning method, you
would add the image to the DOM in a load
event handler, such as by using
the img.onload
event handler, and by
handling the error in the error
event's handler.
js
const img = new Image();
img.src = "nebula.jpg";
img
.decode()
.then(() => {
document.body.appendChild(img);
})
.catch((encodingError) => {
// Do something with the error.
});
Specifications
Specification |
---|
HTML Standard # dom-img-decode-dev |
Browser compatibility
BCD tables only load in the browser