Timeout a promise after a specified amount of time
Go to file
Sindre Sorhus bddde18124 4.0.0 2020-12-01 22:52:59 +07:00
.github Require Node.js 10 2020-12-01 22:50:36 +07:00
.editorconfig Meta tweaks 2017-07-02 03:43:15 +02:00
.gitattributes Require Node.js 8, add TypeScript definition (#10) 2019-03-12 15:17:11 +07:00
.gitignore Meta tweaks 2017-07-02 03:43:15 +02:00
.npmrc Meta tweaks 2017-07-02 03:43:15 +02:00
index.d.ts Require Node.js 10 2020-12-01 22:50:36 +07:00
index.js Require Node.js 10 2020-12-01 22:50:36 +07:00
index.test-d.ts Require Node.js 10 2020-12-01 22:50:36 +07:00
license Move to GitHub Actions 2020-12-01 14:57:27 +07:00
package.json 4.0.0 2020-12-01 22:52:59 +07:00
readme.md Add `customTimers` option (#17) 2020-12-01 22:40:53 +07:00
test.js Add `customTimers` option (#17) 2020-12-01 22:40:53 +07:00

readme.md

p-timeout

Timeout a promise after a specified amount of time

Install

$ npm install p-timeout

Usage

const delay = require('delay');
const pTimeout = require('p-timeout');

const delayedPromise = delay(200);

pTimeout(delayedPromise, 50).then(() => 'foo');
//=> [TimeoutError: Promise timed out after 50 milliseconds]

API

pTimeout(input, milliseconds, message?, options?)

pTimeout(input, milliseconds, fallback?, options?)

Returns a decorated input that times out after milliseconds time.

If you pass in a cancelable promise, specifically a promise with a .cancel() method, that method will be called when the pTimeout promise times out.

input

Type: Promise

Promise to decorate.

milliseconds

Type: number

Milliseconds before timing out.

Passing Infinity will cause it to never time out.

message

Type: string | Error
Default: 'Promise timed out after 50 milliseconds'

Specify a custom error message or error.

If you do a custom error, it's recommended to sub-class pTimeout.TimeoutError.

fallback

Type: Function

Do something other than rejecting with an error on timeout.

You could for example retry:

const delay = require('delay');
const pTimeout = require('p-timeout');

const delayedPromise = () => delay(200);

pTimeout(delayedPromise(), 50, () => {
	return pTimeout(delayedPromise(), 300);
});

options

Type: object

customTimers

Type: object with function properties setTimeout and clearTimeout

Custom implementations for the setTimeout and clearTimeout functions.

Useful for testing purposes, in particular to work around sinon.useFakeTimers().

Example:

const pTimeout = require('p-timeout');
const sinon = require('sinon');

(async () => {
	const originalSetTimeout = setTimeout;
	const originalClearTimeout = clearTimeout;

	sinon.useFakeTimers();

	// Use `pTimeout` without being affected by `sinon.useFakeTimers()`:
	await pTimeout(doSomething(), 2000, undefined, {
		customTimers: {
			setTimeout: originalSetTimeout,
			clearTimeout: originalClearTimeout
		}
	});
})();

pTimeout.TimeoutError

Exposed for instance checking and sub-classing.

  • delay - Delay a promise a specified amount of time
  • p-min-delay - Delay a promise a minimum amount of time
  • p-retry - Retry a promise-returning function
  • More…