es-promise-ext/dist/prototype/timeOut/timeOut.d.ts

Native promise extensions for javascript and typescript.

export type AsyncFunction<T> = () => Promise<T>;
type TimeOutFunction<T> = () => Promise<T> | Promise<never>;
/**
 * Call the async function with time out limit.
 *
 * @param {AsyncFunction<U>} asyncFunction
 * - an async function
 *
 * @param {number} [millisecond=1000]
 * - the time limit for the time out
 *
 * @return {Promise<U> | Promise<never>}
 * The returned promise
 *
 * @example
 * Promise.resolve('a')
 *   .then(timeOut(asyncFunction, 300))
 *   .then(doSomething)
 * // return a promise after with in 300 ms, otherwise reject with time out error
 */
export default function timeOut<U>(asyncFunction: AsyncFunction<U>, millisecond?: number): TimeOutFunction<U>;
/**
 * Return the promise with time out limit.
 *
 * @param {Promise<U>} promise
 * - a promise
 *
 * @param {number} [millisecond=1000]
 * - the time limit for the time out
 *
 * @return {Promise<U> | Promise<never>}
 * The returned promise
 *
 * @example
 * Promise.resolve('a')
 *   .then(timeOut(promise, 300))
 *   .then(doSomething)
 * // return a promise after with in 300 ms, otherwise reject with time out error
 */
export default function timeOut<U>(promise: Promise<U>, millisecond?: number): TimeOutFunction<U>;
export {};