UNPKG

whenever-ready

Version:

A promise that resolves when a value is set.

Richienb/whenever-ready

48 lines (28 loc) • 948 B
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
# Whenever ready [![Travis CI Build Status](https://img.shields.io/travis/com/Richienb/whenever-ready/master.svg?style=for-the-badge)](https://travis-ci.com/Richienb/whenever-ready) A promise that resolves when a value is set. [![NPM Badge](https://nodei.co/npm/whenever-ready.png)](https://npmjs.com/package/whenever-ready) ## Install ```sh npm install whenever-ready ``` ## Usage ```js const WheneverReady = require("whenever-ready"); const wReady = new WheneverReady(); wReady.when().then(() => console.log("READY!")); // Listen for readiness. wReady.ready = true; // Set as ready. ``` ## API ### `class` WheneverReady(ready?) #### ready Type: `boolean`\ Default: `false` The initial readiness value. ### `instance` WheneverReady #### ready Type: `boolean`\ Default: `false` The readiness. #### when() Returns: `Promise` Returns a promise that will resolve when `ready` is true.