Skip to content

sagiegurari/node-later

Repository files navigation

node-later

NPM Version CI Coverage Status Known Vulnerabilities Inline docs License Total Downloads

Defer function calls to the start of the next cycle.

Overview

Invoke functions in the next cycle.
You have multiple node.js APIs to run a function later, for example process.nextTick, setImmediate and setTimeout.
Each of those will invoke the provided function at a different time.
This library enables to extract the "best" API which enables to run a provided function as soon as possible based on the currently node.js runtime version.

Usage

//first you must require this library as follows:
var later = require('node-later');

//get a defer function based on current node.js version
var defer = later();

//or get a defer function based on a specific node.js version
defer = later('0.10.0'); //let be compatible with node.js 0.10 regardless of our current node.js runtime

//or get a defer function which is IO safe (will prevent stack overflow errors)
defer = later(true);

//use defer function
defer(onCallback() {
  //do something
});

Installation

In order to use this library, just run the following npm install command:

npm install --save node-later

API Documentation

See full docs at: API Docs

Contributing

See contributing guide

Release History

Date Version Description
2020-05-11 v2.0.0 Migrate to github actions and upgrade minimal node version
2019-12-16 v1.0.16 Maintenance
2017-04-28 v1.0.0 Offical release
2017-04-28 v0.0.1 Initial release

License

Developed by Sagie Gur-Ari and licensed under the Apache 2 open source license.