delay

Functions

• clearDelay()
• createDelay()
• delay()
• rangeDelay()

Type Aliases

• Options

function clearDelay

clearDelay: (delayPromise: Promise<unknown>) => void;

• Clears the delay and settles the promise.

  If you pass in a promise that is already cleared or a promise coming from somewhere else, it does nothing.

  Example 1

  import delay, {clearDelay} from 'delay';
  
  const delayedPromise = delay(1000, {value: 'Done'});
  
  setTimeout(() => {
  	clearDelay(delayedPromise);
  }, 500);
  
  // 500 milliseconds later
  console.log(await delayedPromise);
  //=> 'Done'

function createDelay

createDelay: (timers: {
    clearTimeout: (timeoutId: any) => void;
    setTimeout: (
        callback: (...args: any[]) => void,
        milliseconds: number,
        ...args: any[]
    ) => unknown;
}) => typeof delay;

• Creates a new delay instance using the provided functions for clearing and setting timeouts. Useful if you're about to stub timers globally, but you still want to use delay to manage your tests.

  Example 1

  import {createDelay} from 'delay';
  
  const customDelay = createDelay({clearTimeout, setTimeout});
  
  const result = await customDelay(100, {value: '🦄'});
  
  // Executed after 100 milliseconds
  console.log(result);
  //=> '🦄'

function delay

delay: <T>(milliseconds: number, options?: Options<T>) => Promise<T>;

• Create a promise which resolves after the specified milliseconds.

  Parameter milliseconds

  Milliseconds to delay the promise.

  Returns

  A promise which resolves after the specified milliseconds.

  Example 1

  import delay from 'delay';
  
  bar();
  
  await delay(100);
  
  // Executed 100 milliseconds later
  baz();

function rangeDelay

rangeDelay: <T>(
    minimum: number,
    maximum: number,
    options?: Options<T>
) => Promise<T>;

• Create a promise which resolves after a random amount of milliseconds between minimum and maximum has passed.

  Useful for tests and web scraping since they can have unpredictable performance. For example, if you have a test that asserts a method should not take longer than a certain amount of time, and then run it on a CI, it could take longer. So with this method, you could give it a threshold instead.

  Parameter minimum

  Minimum amount of milliseconds to delay the promise.

  Parameter maximum

  Maximum amount of milliseconds to delay the promise.

  Returns

  A promise which resolves after a random amount of milliseconds between maximum and maximum has passed.

type Options

type Options<T> = {
    /**
	A value to resolve in the returned promise.

	@example
	```
	import delay from 'delay';

	const result = await delay(100, {value: '🦄'});

	// Executed after 100 milliseconds
	console.log(result);
	//=> '🦄'
	```
	*/
    value?: T;

    /**
	An `AbortSignal` to abort the delay.

	The returned promise will be rejected with an `AbortError` if the signal is aborted.

	@example
	```
	import delay from 'delay';

	const abortController = new AbortController();

	setTimeout(() => {
		abortController.abort();
	}, 500);

	try {
		await delay(1000, {signal: abortController.signal});
	} catch (error) {
		// 500 milliseconds later
		console.log(error.name)
		//=> 'AbortError'
	}
	```
	*/
    signal?: AbortSignal;
};