Timeout a promise after a specified amount of time
Go to file
Sindre Sorhus 63a486a0f2 2.0.0 2017-11-19 16:37:33 +07:00
.editorconfig Meta tweaks 2017-07-02 03:43:15 +02:00
.gitattributes init 2016-10-21 13:42:17 +07:00
.gitignore Meta tweaks 2017-07-02 03:43:15 +02:00
.npmrc Meta tweaks 2017-07-02 03:43:15 +02:00
.travis.yml Meta tweaks 2017-07-02 03:43:15 +02:00
index.js Cancel any cancelable input promises (#3) 2017-11-19 16:33:44 +07:00
license Meta tweaks 2017-07-02 03:43:15 +02:00
package.json 2.0.0 2017-11-19 16:37:33 +07:00
readme.md Document #3 2017-11-19 16:36:02 +07:00
test.js Cancel any cancelable input promises (#3) 2017-11-19 16:33:44 +07:00

readme.md

p-timeout Build Status

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, ms, [message | fallback])

Returns a decorated input that times out after ms 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.

ms

Type: number

Milliseconds before timing 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);
});

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…

License

MIT © Sindre Sorhus