get-ready

mixin to add one-time ready event callback handler

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
get-ready
213.1.08 months ago9 years agoMinified + gzip package size for get-ready in KB

Readme

get-ready
!NPM versionnpm-imagenpm-url CI !Test coveragecodecov-imagecodecov-url !npm downloaddownload-imagedownload-url
Fork from supershabam/ready
one-time ready event object.

Usage

Create ready event object.
import { Ready } from 'get-ready';

const obj = new Ready();

// register a callback
obj.ready(() => console.log('ready'));

// mark ready
obj.ready(true);

Register

Register a callback to the callback stack, it will be called when mark as ready, see example above.
If the callback is undefined, register will return a promise.
obj.ready().then(() => console.log('ready'));
obj.ready(true);

If it has been ready, the callback will be called immediately.
// already ready
obj.ready(true);
obj.ready().then(() => console.log('ready'));

Warning: the callback is called after nextTick

Emit

Mark it as ready, you can simply using .ready(true).
You can also mark it not ready.
obj.ready(true);
// call immediately
obj.ready(() => console.log('ready'));

obj.ready(false);
obj.ready(() => throw 'don\'t run');

When exception throws, you can pass an error object, then the callback will receive it as the first argument.
obj.ready(err => console.log(err));
obj.ready(new Error('err'));

License

MIT

Contributors

|
supershabam

|
fengmk2

|
popomore

|
dead-horse

|
semantic-release-bot

| | :---: | :---: | :---: | :---: | :---: |
This project follows the git-contributor spec, auto updated at Mon Jun 05 2023 14:06:50 GMT+0800.