6.1.2 • Published 10 months ago

p-timeout v6.1.2

Weekly downloads
11,248,826
License
MIT
Repository
github
Last release
10 months ago

p-timeout

Timeout a promise after a specified amount of time

Install

npm install p-timeout

Usage

import {setTimeout} from 'node:timers/promises';
import pTimeout from 'p-timeout';

const delayedPromise = setTimeout(200);

await pTimeout(delayedPromise, {
	milliseconds: 50,
});
//=> [TimeoutError: Promise timed out after 50 milliseconds]

API

pTimeout(input, options)

Returns a decorated input that times out after milliseconds time. It has a .clear() method that clears the timeout.

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.

options

Type: object

milliseconds

Type: number

Milliseconds before timing out.

Passing Infinity will cause it to never time out.

message

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

Specify a custom error message or error to throw when it times out:

  • message: 'too slow' will throw TimeoutError('too slow')
  • message: new MyCustomError('it’s over 9000') will throw the same error instance
  • message: false will make the promise resolve with undefined instead of rejecting

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

import {TimeoutError} from 'p-timeout';

class MyCustomError extends TimeoutError {
	name = "MyCustomError";
}
fallback

Type: Function

Do something other than rejecting with an error on timeout.

You could for example retry:

import {setTimeout} from 'node:timers/promises';
import pTimeout from 'p-timeout';

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

await pTimeout(delayedPromise(), {
	milliseconds: 50,
	fallback: () => {
		return pTimeout(delayedPromise(), {milliseconds: 300});
	},
});
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:

import {setTimeout} from 'node:timers/promises';
import pTimeout from 'p-timeout';

const originalSetTimeout = setTimeout;
const originalClearTimeout = clearTimeout;

sinon.useFakeTimers();

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

signal

Type: AbortSignal

You can abort the promise using AbortController.

Requires Node.js 16 or later.

import pTimeout from 'p-timeout';
import delay from 'delay';

const delayedPromise = delay(3000);

const abortController = new AbortController();

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

await pTimeout(delayedPromise, {
	milliseconds: 2000,
	signal: abortController.signal
});

TimeoutError

Exposed for instance checking and sub-classing.

Related

  • 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…
p-eventp-queue@braum-ai/sdkcomponennentt@chat-bots/goatchat-apivuedragdropuploadimagescad-cligohiei-bull@shipengine/cli@shipengine/integration-platform-cli@skylar745/3box@mc3-aether/aetherniouz-apilumerin-wallet-corettio@olivervorasai/slidercogoportutilsdyx-reacttalent-to-vite-cliunblock-block-save-variables@saaspe/components@leonzalion/p-wait-for@pixiebrix/extensionexpand-react-bridgeopea-bootstraap@everything-registry/sub-chunk-2396@314oner_npm/universal-components-librarycustom-gpt-userp149-tabletest-popupsnode-chatgpt-apinidlenimrod-data-downloadernitro-sandboxnka-gantt-task-reactnode-common-sdkmodbusdbmrfastdie-twitch-jsmtbird-chatgptmicro-sub-climomenticmorticemqtt-bridge-doorbirdmqtt-bridge-teslamqtt-bridge-veramy-temp-clinewsmsboomerluojia-cli-devmiguelcostero-ng2-toastymama-exporterminecraft-proxymetascraper-media-providermetronome-wallet-corenormalize-url-plusnois-react-toastnpnpnbnsracemavectrantpy@valiantpepper/chatgpt@valiantpepper/chatgpt-streamable@tzzack/chatgpt@vitali_shcherbina/styled-lib@twinklepkg/chatgpt@tv2media/timeline-state-resolver@turf-rs/turf@types/p-timeout@xsahxl/got@xuhaojun/p-queueaireader@xswap/v2-core@vue-helper/vue-keep-alive@wrecking-ball-software/bullalinagptalinagpt-v3aliyun-serverless-wrapper@yak-spirit/yak-swap-ui@yhostc/chatbot-puppet@yhostc/chatgptaimix@xx-johnwick-xx/cloud9@zenghongtu/chatgptabccorea-js@wfatec/chatgpt@virtuslab/react-oauth2@zitao/p-queue@zitao/telegraf@vucod/emailadccorea-jsadcorea-jsandy-chatgpt@aristidenf/streak-counter@arkasuryawan/m2-interface@arnagos/p-queueauto-steps@aigcaas/chatgptappcharge-checkoutappcharge-checkout-reactjs-sdkap-vue-captcha
6.1.2

10 months ago

6.1.0

1 year ago

6.1.1

1 year ago

5.1.0

2 years ago

6.0.0

2 years ago

5.0.2

2 years ago

5.0.1

2 years ago

5.0.0

3 years ago

4.1.0

3 years ago

4.0.1

3 years ago

4.0.0

3 years ago

3.2.0

5 years ago

3.1.0

5 years ago

3.0.0

5 years ago

2.0.1

6 years ago

2.0.0

6 years ago

1.2.1

6 years ago

1.2.0

7 years ago

1.1.1

7 years ago

1.1.0

7 years ago

1.0.0

7 years ago