# assets-preloader

> load web assets, like js, css, image, and return a promise

Latest version **1.7.0** (published 2019-03-31) · ISC license · 0 weekly downloads

## Install

```sh
npm install assets-preloader
pnpm add assets-preloader
yarn add assets-preloader
bun add assets-preloader
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.7.0 |
| Published | 2019-03-31 |
| First published | 2019-03-23 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 9.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Maintainers | huruji |

## Links

- npm: https://www.npmjs.com/package/assets-preloader
- Repository: https://github.com/huruji/assets-preloader
- Homepage: https://github.com/huruji/assets-preloader#readme
- Issues: https://github.com/huruji/assets-preloader/issues
- npm.io page: https://npm.io/package/assets-preloader

## Recent versions

- 1.7.0 (latest) — 2019-03-31
- 1.4.0 — 2019-03-25
- 1.1.0 — 2019-03-24
- 1.0.1 — 2019-03-24
- 1.0.0 — 2019-03-23

## README

<p>
<img src="./logo.png" width="300"/>
<p>


# assets-preloader
load web assets, like js, css, image, and return a promise

> notice: assets-preloader only support image assets now, other assets will be as features in next version
## example

![](./preloader-example.gif)

see [Example](./example/README.md)

## How to use

```bash
npm i assets-preloader -S
```

```js
import Preloader from 'assets-preloader'

const imgs = [
  // your imgs
  // like 'http://assets-preload.io/logo.png'
]

const loader = new Preloader(imgs)

loader.listen('progress', (val) => {
  // your code when progress events emited
  // like: console.log(val)
})

// start load
loader.load().then(() => {
  // your code when all assets loaded
  // like console.log('success')
})
```

## Api

`Preloader` is a class, so you need init an instance

```js
const loader = new Preloader(assets)
```
### `.load`

start to load assets, it returns a `promise`

```js
loader.load().then(() => {
  // your code
})
```

### `.listen`

listen `progress` or `error` events

```js
loader.listen('progress', (val) => {
  console.log(`Loading progress is ${val}`)
})
```

### `.addEventListener`
`alias` of `.listen`

### `.add`

add asset to load

```js
loader.add('myasset.png')
```
## Events

### progress

Emited when asset loading completed, it's parameter is a progress number


### error

Emited when asset loading error, it's parameter is an `Error`


**Listening event**: you can use `onprogress` or `listen` or `addEventListener`

```js
loader.listen('progress', (val) => {
  // your code when progress events emited
  // like: console.log(val)
})

// equal to

loader.addEventListener('progress', (val) => {
  // your code when progress events emited
  // like: console.log(val)
})

// equal to

loader.onprogress = (val) => {
  // your code when progress events emited
  // like: console.log(val)
}
```


## How to build

```js
npm run build
```

## How to release

`assets-preloader` is using `standard-version`

```bash
# release as a major version
npm run release:major

#release as a major version
npm run release:minor

#release as a patch version
npm run release:patch

```

---
_Source: https://npm.io/package/assets-preloader · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
