@timsuchanek/sleep-promise

What is @timsuchanek/sleep-promise?

The @timsuchanek/sleep-promise package is a simple utility that allows you to pause the execution of asynchronous code for a specified amount of time. It is useful for introducing delays in your code, such as waiting for a certain condition to be met or throttling requests.

What are @timsuchanek/sleep-promise's main functionalities?

Basic Sleep Functionality

This feature allows you to pause the execution of your code for a specified duration. In the example, the code logs 'Start', waits for 2 seconds, and then logs 'End'.

const sleep = require('@timsuchanek/sleep-promise');

async function example() {
  console.log('Start');
  await sleep(2000); // Sleep for 2 seconds
  console.log('End');
}

example();

Other packages similar to @timsuchanek/sleep-promise

sleep-promise

The sleep-promise package provides similar functionality by allowing you to pause execution for a specified duration. It is a lightweight and straightforward alternative to @timsuchanek/sleep-promise, offering the same basic sleep functionality.

delay

The delay package is another alternative that provides a promise-based delay function. It offers additional features such as cancelable delays and is more feature-rich compared to @timsuchanek/sleep-promise, which focuses on simplicity.

await-sleep

The await-sleep package provides a simple sleep function that can be used with async/await syntax. It is similar in functionality to @timsuchanek/sleep-promise, focusing on providing a straightforward way to introduce delays in asynchronous code.

README

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