p-timeout/readme.md

88 lines
1.9 KiB
Markdown
Raw Normal View History

2016-10-21 06:42:17 +00:00
# p-timeout [![Build Status](https://travis-ci.org/sindresorhus/p-timeout.svg?branch=master)](https://travis-ci.org/sindresorhus/p-timeout)
> Timeout a promise after a specified amount of time
## Install
```
2017-07-02 01:43:15 +00:00
$ npm install p-timeout
2016-10-21 06:42:17 +00:00
```
## Usage
```js
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?)
### pTimeout(input, milliseconds, fallback?)
2016-10-21 06:42:17 +00:00
2019-03-12 08:21:47 +00:00
Returns a decorated `input` that times out after `milliseconds` time.
2016-10-21 06:42:17 +00:00
2017-11-19 09:36:02 +00:00
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.
2016-10-21 06:42:17 +00:00
#### input
Type: `Promise`
Promise to decorate.
2019-03-12 08:21:47 +00:00
#### milliseconds
2016-10-21 06:42:17 +00:00
Type: `number`
Milliseconds before timing out.
Passing `Infinity` will cause it to never time out.
2016-10-21 06:42:17 +00:00
#### message
Type: `string` `Error`<br>
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:
```js
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.
## Related
- [delay](https://github.com/sindresorhus/delay) - Delay a promise a specified amount of time
2016-11-20 13:04:08 +00:00
- [p-min-delay](https://github.com/sindresorhus/p-min-delay) - Delay a promise a minimum amount of time
2016-10-21 06:42:17 +00:00
- [p-retry](https://github.com/sindresorhus/p-retry) - Retry a promise-returning function
- [More…](https://github.com/sindresorhus/promise-fun)