functionReturns a defer function.
6 |functionReturns a defer function.
9 |function
15 | Returns a defer function.
16 |
17 | **Kind**: global function
18 | **Returns**: function - A defer function
19 | **Access**: public
20 |
21 | | Param | Type | Default | Description |
22 | | --- | --- | --- | --- |
23 | | [ioSafe] | Boolean | false | True ensure IO safe implementation which will prevent stack overflow errors |
24 |
25 | **Example**
26 | ```js
27 | //get a defer function
28 | const defer = later();
29 |
30 | //use defer function
31 | defer(onCallback() {
32 | //do something
33 | });
34 | ```
35 |
36 |
37 | ## later([comptibleVersion]) ⇒ function
38 | Returns a defer function.
39 |
40 | **Kind**: global function
41 | **Returns**: function - A defer function
42 | **Access**: public
43 |
44 | | Param | Type | Default | Description |
45 | | --- | --- | --- | --- |
46 | | [comptibleVersion] | String | process.version.substring(1) | The nodejs version the defer function should be compatible with |
47 |
48 | **Example**
49 | ```js
50 | //get a defer function based on current nodejs version
51 | const defer = later();
52 |
53 | //use defer function
54 | defer(onCallback() {
55 | //do something
56 | });
57 |
58 | //get a defer function based on a specific node.js version
59 | defer = later('0.10.0'); //let be compatible with node.js 0.10 regardless of our current node.js runtime
60 |
61 | //use defer function
62 | defer(onCallback() {
63 | //do something
64 | });
65 | ```
66 |
--------------------------------------------------------------------------------
/lib/node-later.js:
--------------------------------------------------------------------------------
1 | 'use strict';
2 |
3 | const semver = require('semver');
4 |
5 | /*eslint-disable valid-jsdoc*/
6 | //jscs:disable jsDoc
7 | /**
8 | * Returns a defer function.
9 | *
10 | * @function
11 | * @alias later
12 | * @public
13 | * @param {Boolean} [ioSafe=false] - True ensure IO safe implementation which will prevent stack overflow errors
14 | * @returns {function} A defer function
15 | * @example
16 | * ```js
17 | * //get a defer function
18 | * const defer = later();
19 | *
20 | * //use defer function
21 | * defer(onCallback() {
22 | * //do something
23 | * });
24 | * ```
25 | *
26 | * @also
27 | *
28 | * Returns a defer function.
29 | *
30 | * @function
31 | * @alias later
32 | * @public
33 | * @param {String} [comptibleVersion=process.version.substring(1)] - The nodejs version the defer function should be compatible with
34 | * @returns {function} A defer function
35 | * @example
36 | * ```js
37 | * //get a defer function based on current nodejs version
38 | * const defer = later();
39 | *
40 | * //use defer function
41 | * defer(onCallback() {
42 | * //do something
43 | * });
44 | *
45 | * //get a defer function based on a specific node.js version
46 | * defer = later('0.10.0'); //let be compatible with node.js 0.10 regardless of our current node.js runtime
47 | *
48 | * //use defer function
49 | * defer(onCallback() {
50 | * //do something
51 | * });
52 | * ```
53 | */
54 | const later = function (comptibleVersionOrIOSafe) {
55 | let deferFn = process.nextTick;
56 |
57 | if (comptibleVersionOrIOSafe) {
58 | if (typeof comptibleVersionOrIOSafe === 'boolean') {
59 | deferFn = setImmediate;
60 | } else if (semver.lt(comptibleVersionOrIOSafe, '0.12.0')) {
61 | deferFn = setImmediate;
62 | }
63 | } else if (semver.lt(later.nodejsVersion, '0.12.0')) {
64 | deferFn = setImmediate;
65 | }
66 |
67 | return deferFn;
68 | };
69 | //jscs:enable jsDoc
70 | /*eslint-enable valid-jsdoc*/
71 |
72 | later.nodejsVersion = process.version.substring(1);
73 |
74 | module.exports = later;
75 |
--------------------------------------------------------------------------------
/test/spec/node-later-spec.js:
--------------------------------------------------------------------------------
1 | 'use strict';
2 |
3 | const chai = require('chai');
4 | const assert = chai.assert;
5 | const later = require('../../lib/node-later');
6 |
7 | describe('later', function () {
8 | describe('get', function () {
9 | it('undefined', function (done) {
10 | const defer = later();
11 | defer(done);
12 | });
13 |
14 | it('null', function (done) {
15 | const defer = later(null);
16 | defer(done);
17 | });
18 |
19 | it('ioSafe', function (done) {
20 | const defer = later(true);
21 | assert.strictEqual(setImmediate, defer);
22 | defer(done);
23 | });
24 |
25 | it('requested 0.12.0', function (done) {
26 | const defer = later('0.12.0');
27 | assert.strictEqual(process.nextTick, defer);
28 | defer(done);
29 | });
30 |
31 | it('requested 0.12.1', function (done) {
32 | const defer = later('0.12.1');
33 | assert.strictEqual(process.nextTick, defer);
34 | defer(done);
35 | });
36 |
37 | it('requested 0.10.x', function (done) {
38 | const defer = later('0.10.1000');
39 | assert.strictEqual(setImmediate, defer);
40 | defer(done);
41 | });
42 |
43 | it('runtime 0.12.0', function (done) {
44 | const nodejsVersion = later.nodejsVersion;
45 | later.nodejsVersion = '0.12.0';
46 |
47 | const defer = later();
48 | later.nodejsVersion = nodejsVersion;
49 |
50 | assert.strictEqual(process.nextTick, defer);
51 | defer(done);
52 | });
53 |
54 | it('runtime 0.12.1', function (done) {
55 | const nodejsVersion = later.nodejsVersion;
56 | later.nodejsVersion = '0.12.1';
57 |
58 | const defer = later();
59 | later.nodejsVersion = nodejsVersion;
60 |
61 | assert.strictEqual(process.nextTick, defer);
62 | defer(done);
63 | });
64 |
65 | it('runtime 0.10.x', function (done) {
66 | const nodejsVersion = later.nodejsVersion;
67 | later.nodejsVersion = '0.10.1000';
68 |
69 | const defer = later();
70 | later.nodejsVersion = nodejsVersion;
71 |
72 | assert.strictEqual(setImmediate, defer);
73 | defer(done);
74 | });
75 | });
76 | });
77 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # node-later
2 |
3 | [](https://www.npmjs.org/package/node-later) [](https://github.com/sagiegurari/node-later/actions) [](https://coveralls.io/r/sagiegurari/node-later) [](https://snyk.io/test/github/sagiegurari/node-later) [](http://inch-ci.org/github/sagiegurari/node-later) [](https://github.com/sagiegurari/node-later/blob/master/LICENSE) [](https://www.npmjs.org/package/node-later)
4 |
5 | > Defer function calls to the start of the next cycle.
6 |
7 | * [Overview](#overview)
8 | * [Usage](#usage)
9 | * [Installation](#installation)
10 | * [API Documentation](docs/api.md)
11 | * [Contributing](.github/CONTRIBUTING.md)
12 | * [Release History](#history)
13 | * [License](#license)
14 |
15 |
16 | ## Overview
17 | Invoke functions in the next cycle.