get-ready

=====

Fork from supershabam/ready

NodeJS mixin to add one-time ready event

Usage

Using ready or ready.mixin to add ready method to the given object.

1const ready = require('get-ready');
2const obj = {};
3ready.mixin(obj);
4
5// register a callback
6obj.ready(() => console.log('ready'));
7
8// mark ready
9obj.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.

1obj.ready().then(() => console.log('ready'));
2obj.ready(true);

If it has been ready, the callback will be called immediately.

1// already ready
2obj.ready(true);
3obj.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.

1obj.ready(true);
2// call immediately
3obj.ready(() => console.log('ready'));
4
5obj.ready(false);
6obj.ready(() => throw 'don\'t run');

When exception throws, you can pass an error object, then the callback will receive it as the first argument.

1obj.ready(err => console.log(err));
2obj.ready(new Error('err'));

License

MIT