Skip to content

loadImage

Load a given image.

Usage

js
import { loadImage } from '@studiometa/js-toolkit/utils';

const src = '/path/to/my/image.jpg';
const { event, element } = await loadImage(src);

if (event.type === 'error') {
  console.log(`Failed to load ${src}: ${event.message}`);
} else {
  console.log(`${src} has been loaded!`);
}

Parameters

  • src (string): the source URL to load
  • options ({ appendTo?: HTMLElement }): configure the loader behavior
    • options.appendTo (HTMLElement): append the created element to a DOM element

Return value

  • Promise<{ event: Event, element: HTMLelement }>: a promise resolving to an object containing both the load event object and the created element

MIT Licensed