@randajan/sleep

Tiny async utilities for timeout and sleep using native Promises.

I was tired of writing it again and again

Installation

npm install @randajan/sleep

Usage

import { sleep, timeout, prolong, withTimeout } from "@randajan/sleep";

// Wait 500ms and resolve with "done"
await sleep(500, "done");

// Wait 500ms and reject with "Timeout"
await timeout(500);

// Wait 1000ms and resolve with "OK"
await prolong(1000, true, "OK");

// Wait 1000ms and reject with custom error
await prolong(1000, false, new Error("Custom timeout"));

// Wrap any promise and reject if it does not resolve in time
await withTimeout(fetch(url), 2000);

API

sleep(ms, result)

Resolves result after ms milliseconds.

timeout(ms, error)

Rejects error after ms milliseconds (default: new Error("Timeout")).

prolong(ms, ok, result)

Resolves (if ok is true) or rejects (if false) with result after ms milliseconds.

withTimeout(promise, ms, error)

Resolves or rejects with promise, but rejects with error after ms milliseconds.

License

MIT