# whs-module-loader

> Loading progress for components, textures, ...

Latest version **0.1.0** (published 2017-04-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install whs-module-loader
pnpm add whs-module-loader
yarn add whs-module-loader
bun add whs-module-loader
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2017-04-07 |
| First published | 2017-04-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6368 |
| Author | Alexander Buzin |
| Maintainers | alex2401 |
| Keywords | whs-module, loader |

## Links

- npm: https://www.npmjs.com/package/whs-module-loader
- Repository: https://github.com/WhitestormJS/whitestorm.js/tree/beta/modules/whs-module-loader
- npm.io page: https://npm.io/package/whs-module-loader

## Dependencies (1)

- [minivents](https://npm.io/package/minivents.md) ^2.0.2

## Recent versions

- 0.1.0 (latest) — 2017-04-07

## README

# whs-module-loader - Loading progress for components, textures, ...

## Usage

### `constructor(expecting = [])`

> `expecting` - `Array` of _keys `[String]`_ that will be added to `.expecting`

### `.expect(key)` and `.resolve(key)` - Use for callbacks

```javascript
const loader = new LoaderModule();

const app = new WHS.App([
  // ...
])''

loader.expect('sphere1');

const sphere = new WHS.Sphere({
  // ...
});

sphere.addTo(app).then(() => loader.resolve('sphere1'));
```

### `.promise(key, promise)` - Use for promises

> No `.expect()` required!

```javascript
loader.promise('sphere1', sphere.addTo(app));
```

### `.getProgress()` - Get loading progress

Returns value from `0` to `1`, where `1` means **completed**.

Can be transformed into percents simply muliplying by `100`: 

```javascript
console.log(`Current percent is: ${loader.getProgress() * 100}`);
```

## Events

### `.on('step', [Callback])`

```javascript
loader.on('step', key => {
  console.log(key);
});
```

### `.on('complete', [Callback])`

```javascript
loader.on('complete', () => {
  alert('completed!');
});
```

Fires when `.resolve()` was called and `.expecting` is empty.

## Attributes

### `.expecting`

```javascript
console.log(loader.expecting);
// Array of keys that aren't resolved yet.
```

> This attribute represents an `Array` of _keys `[String]`_ values that **are not resolved yet**.

### `.resolved`

```javascript
console.log(loader.resolved);
// Array of keys that have been resolved.
```

> `Array` of resolved keys.

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