@timsuchanek/sleep-promise

sleep-promise

sleep-promise resolves a promise after a specified delay.

Installation

node.js

npm install sleep-promise

Usage async / await

import sleep from 'sleep-promise';

(async () => {
    await sleep(2000);
    console.log('2 seconds later …');
})();

Usage ES5

var sleep = require('sleep-promise');

sleep(2000).then(function() {
    console.log('2 seconds later …');
});

Usage in a promise chain

import sleep from 'sleep-promise';

let trace = value => {
    console.log(value);
    return value;
};

sleep(2000)
    .then(() => 'hello')
    .then(trace)
    .then(sleep(1000))
    .then(value => value + ' world')
    .then(trace)
    .then(sleep(500))
    .then(value => value + '!')
    .then(trace);

// [2 seconds sleep]
// hello
// [1 second sleep]
// hello world
// [500 ms sleep]
// hello world!

Usage in a test file that mocks setTimeout

import sinon from 'sinon';
import sleep from 'sleep-promise';

const clock = sinon.useFakeTimers();

(async () => {
    // 2 seconds faked by sinon
    const sleepPromise = sleep(2000);
    clock.tick(2000);
    await sleepPromise;
    console.log('instant');

    // Caches global setTimeout before sinon replaced it
    const sleepPromise2 = sleep(2000, { useCachedSetTimeout: true });
    clock.tick(2000);
    await sleepPromise2;
    console.log('2 seconds later');
})();

License

MIT

Changelog

<small>8.0.1 (2018-06-06)</small>

• Add coveralls (4d6405c)
• Add license information to readme (48671ce)
• Fix CI code test coverage (36303f2)
• Fix license link (2661144)
• Remove default value for createSleepPromise options (c683f77)
• v8.0.1 (8abf89e)