Big update!Introducing GitHub Bot Commands. Learn more
Socket
Log inBook a demo

p-timeout

Package Overview
Dependencies
0
Maintainers
1
Versions
18
Issues
File Explorer

Advanced tools

p-timeout

Timeout a promise after a specified amount of time

    6.0.0latest

Version published
Maintainers
1
Weekly downloads
11,581,313
decreased by-12.14%

Weekly downloads

Changelog

Source

Breaking

  • Require Node.js 14 eb1730b
  • Move the secondary parameters into the options parameter (#29) d7920ca
    • milliseconds is moved into options
    • message is moved into options
    • fallback is moved into options
    • Example: https://github.com/sindresorhus/p-timeout/commit/d7920cae0a494292d50d18cc1f0c1a639dd950a3#diff-7aa4473ede4abd9ec099e87fec67fd57afafaf39e05d493ab4533acc38547eb8L116-R128

https://github.com/sindresorhus/p-timeout/compare/v5.1.0...v6.0.0

Readme

Source

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
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:

import {setTimeout} from 'node:timers/promises'; import pTimeout from 'p-timeout'; const delayedPromise = () => setTimeout(200); await pTimeout(delayedPromise(), { milliseconds: 50, fallback: () => { return pTimeout(delayedPromise(), 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.

  • 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…

Keywords

FAQs

What is p-timeout?

Timeout a promise after a specified amount of time

Is p-timeout popular?

The npm package p-timeout receives a total of 9,240,705 weekly downloads. As such, p-timeout popularity was classified as popular.

Is p-timeout well maintained?

We found that p-timeout demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago.It has 1 open source maintainer collaborating on the project.

Last updated on 25 Jul 2022

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc