@cdellacqua/sleep

Delay execution using Promises.

This library implements a sleep function that uses setTimeout under the hood to create a Promise that resolves after a specified number of milliseconds.

Contrary to the bare setTimeout function, this library also supports delays greater than 2147483647 (0x7fffffff, ~24.8 days).

NPM Package

npm install @cdellacqua/sleep

Documentation

Highlights

Basic usage example:

import {sleep} from '@cdellacqua/sleep';

sleep(1000).then(() => console.log('see you in a sec!'));

Same example, with await:

import {sleep} from '@cdellacqua/sleep';

async function example() {
	await sleep(1000);
	console.log('see you in a sec!');
}

Abort timeout after 500ms, rejecting the promise:

import {sleep} from '@cdellacqua/sleep';

async function example() {
	try {
		await sleep(1000, {signal: AbortSignal.timeout(500)});
	} catch (err) {
		console.log('see you in half a sec!');
	}
}

Skip timeout after 500ms:

import {sleep} from '@cdellacqua/sleep';

async function example() {
	// Note the `.catch(...)`!
	await sleep(1000, {signal: AbortSignal.timeout(500)}).catch(() => {});
	console.log('see you in half a sec!');
}

Abort timeout when an event happens, rejecting the promise:

import {sleep} from '@cdellacqua/sleep';

async function example() {
	const controller = new AbortController();
	window.addEventListener('click', () => {
		controller.abort();
	});
	try {
		await sleep(1000, {signal: controller.signal});
		console.log('nobody clicked within 1 second!');
	} catch (err) {
		console.log('somebody clicked within 1 second!');
	}
}

Use custom setTimeout/clearTimeout implementation:

import {sleep} from '@cdellacqua/sleep';

async function example() {
	await sleep(1000, {
		timeoutApi: {
			setTimeout: (callback, ms) => setTimeout(callback, ms * 3),
			clearTimeout: (timeoutId) => clearTimeout(timeoutId),
		},
	});
	console.log('see you in... 3 seconds?');
}