https://github.com/node-modules/ready-callback
Launch server after all async task ready
https://github.com/node-modules/ready-callback
ready
Last synced: 11 days ago
JSON representation
Launch server after all async task ready
- Host: GitHub
- URL: https://github.com/node-modules/ready-callback
- Owner: node-modules
- Created: 2015-02-03T17:20:39.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2023-10-11T02:30:26.000Z (over 1 year ago)
- Last Synced: 2025-05-12T18:56:00.643Z (about 1 month ago)
- Topics: ready
- Language: TypeScript
- Homepage:
- Size: 73.2 KB
- Stars: 26
- Watchers: 3
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# ready-callback
[![NPM version][npm-image]][npm-url]
[](https://github.com/node-modules/ready-callback/actions/workflows/nodejs.yml)
[![Test coverage][codecov-image]][codecov-url]
[![npm download][download-image]][download-url]
[npm-image]: https://img.shields.io/npm/v/ready-callback.svg?style=flat-square
[npm-url]: https://npmjs.org/package/ready-callback
[codecov-image]: https://codecov.io/github/node-modules/ready-callback/coverage.svg?branch=master
[codecov-url]: https://codecov.io/github/node-modules/ready-callback?branch=master
[download-image]: https://img.shields.io/npm/dm/ready-callback.svg?style=flat-square
[download-url]: https://npmjs.org/package/ready-callback
Launch server after all async task ready
---
## Install
```bash
$ npm install ready-callback
```
## Usage
**Note: ready-callback is using `class`, so you should use node>=2**
```js
var koa = require('koa');
var ready = require('ready-callback')();
var app = koa();
ready.mixin(app);
// register a service
var done = app.readyCallback('service');
serviceLaunch(done);
// callback will be fired after all service launched
app.ready(function() {
app.listen();
});
```
### Error Handle
If task is called with error, `error` event will be emit, `ready` will never be called.
```js
// register a service that will emit error
var done = app.readyCallback('service');
serviceLaunch(function(err) {
done(err);
});
// listen error event
app.on('error', function(err) {
// catch error
});
```
### Weak Dependency
If you set a task weak dependency, task will be done without emit `error`.
```js
var done = app.readyCallback('service', {isWeakDep: true});
serviceLaunch(function(err) {
done(err);
});
// will be ready
app.ready(function() {
app.listen();
});
app.on('error', function(err) {
// never be called
});
```
You can also set for all ready-callback
```js
var ready = require('ready-callback')({isWeakDep: true});
```
### Ready Status
You can get status every callback end.
```js
app.on('ready_stat', function(data) {
console.log(data.id); // id of the ended task
console.log(data.remain); // tasks waiting to be ended
});
```
### Timeout
You can set timeout when a task run a long time.
```js
var ready = require('ready-callback')({timeout: 1000});
ready.mixin(app);
app.on('ready_timeout', function(id) {
// this will be called after 1s that `service` task don't complete
});
var done = app.readyCallback('service');
serviceLaunch(function() {
// run a long time
done();
});
```
You can also set timeout for every task
```js
ready.mixin(app);
app.on('ready_timeout', function(id) {
// this will be called after 1s that `service` task don't complete
});
var done = app.readyCallback('service1', {timeout: 1000});
serviceLaunch(done);
```
### lazyStart
You can set a ready-callback object to lazyStart. It will not check
ready status immediately, and should start manualy to check ready
status.
```js
var ready = require('ready-callback')({ lazyStart: true });
yield sleep(1);
// ready obj is not ready
ready.start();
yield sleep(1);
// ready obj is ready now
```
## LISENCE
Copyright (c) 2015 popomore. Licensed under the MIT license.
## Contributors
|[
popomore](https://github.com/popomore)
|[
fengmk2](https://github.com/fengmk2)
|[
semantic-release-bot](https://github.com/semantic-release-bot)
|[
greenkeeperio-bot](https://github.com/greenkeeperio-bot)
|[
killagu](https://github.com/killagu)
|[
liuhanqu](https://github.com/liuhanqu)
|
| :---: | :---: | :---: | :---: | :---: | :---: |
This project follows the git-contributor [spec](https://github.com/xudafeng/git-contributor), auto updated at `Wed Oct 11 2023 10:27:33 GMT+0800`.