https://github.com/zeecoder/z-image-preloader

Image preloading with promise support.
https://github.com/zeecoder/z-image-preloader

module preloader promise

Last synced: about 1 month ago
JSON representation

Image preloading with promise support.

• Host: GitHub
• URL: https://github.com/zeecoder/z-image-preloader
• Owner: ZeeCoder
• License: mit
• Created: 2015-06-12T07:23:27.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2019-11-08T14:10:47.000Z (about 5 years ago)
• Last Synced: 2024-04-30T02:02:11.280Z (8 months ago)
• Topics: module, preloader, promise
• Language: JavaScript
• Homepage:
• Size: 8.79 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# z-image-preloader

[![npm version](https://badge.fury.io/js/z-image-preloader.svg)](http://badge.fury.io/js/z-image-preloader)

Creates a [promise object](https://promisesaplus.com/) which is resolved when

all images are loaded.

Note: The module depends on the global `Promise` object to be available.

Since it's a CommonJS module, you must use a build tool to use it, like

[Browserify](http://browserify.org/), or [webpack](http://webpack.github.io/).

## Example, explanation

```js

const preloader = require("z-image-preloader");

// load single image

preloader

    .load("http://some-url/some-image.png")

    .then(img => {

        // done loading

    })

    .catch(e => {

        // failed to load

    });

// The `batchLoad` method accepts an array of url strings. (Or a single url.)

// The returned promise will be resolved, when all images are loaded (or failed to load)

preloader

    .batchLoad([

        "http://some-url/some-image.png",

        "http://some-other-url/some-other-image.jpg",

        "non-existent-image"

    ])

    .then((img1, img2, err) => {

        // Do something when preloading is done.

        // The arguments here will contain the loaded image objects created by `document.createElement('img')` and possible Error objects.

        // The above call for example will return with two `HTMLImageElement` and an `Error`.

    });

```

## LICENSE

[MIT](LICENSE)