Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

promiseout

Cereceres15ISC0.0.3

reject the promise if timeout is broken

primise, timeout, reject, broken, rejected, bluebird

readme

promise-timeout

extends native promise to get timeout in params. Nodejs > 6 is required.

Usage

const promiseTimeout = require('promise-timeout')

promiseTimeout((resolve) => setTimeout(resolve, 3000), 2000)
    .catch((error) => {
        assert(error.message === 'timeout broken');
    });

promiseTimeout((resolve) => setTimeout(resolve, 1000), 2000)
    .then(// flow is here)

const p = new promiseTimeout((resolve) => setTimeout(resolve, 1000));
promiseTimeout(p, 2000)
    .then(// flow is here)

const p = new promiseTimeout((resolve) => setTimeout(resolve, 3000));
promiseTimeout(p, 2000)
    .catch((error) => {
        assert(error.message === 'timeout broken');
    });

API

promise-timeout(handler=Promise.resolve(),timeout=3000)-> Promise

Receive the handler what is passed to Promise class and timeout. If timeout is broken the promise is rejected.

The handler can be a promise instance.