es-promise-ext
Version:
Native promise extensions for javascript and typescript.
38 lines (37 loc) • 1.11 kB
TypeScript
export type AsyncFunction<T> = () => Promise<T>;
/**
* Call the async function with time out limit.
*
* @param {AsyncFunction<T>} asyncFunction
* - an async function
*
* @param {number} [millisecond=1000]
* - the time limit for the time out
*
* @return {Promise<T> | Promise<never>}
* The returned promise
*
* @example
* promiseTimeOut(asyncFunction, 300)
* .then(doSomething)
* // return a promise within 300 ms, otherwise reject with time out error
*/
export default function promiseTimeOut<T>(asyncFunction: AsyncFunction<T>, millisecond?: number): Promise<T> | Promise<never>;
/**
* Return the promise with time out limit.
*
* @param {Promise<T>} promise
* - a promise
*
* @param {number} [millisecond=1000]
* - the time limit for the time out
*
* @return {Promise<T> | Promise<never>}
* The returned promise
*
* @example
* promiseTimeOut(promise, 300)
* .then(doSomething)
* // return a promise within 300 ms, otherwise reject with time out error
*/
export default function promiseTimeOut<T>(promise: Promise<T>, millisecond?: number): Promise<T> | Promise<never>;