Class TimeoutRunner<T>

constructor

• new TimeoutRunner<T>(maxMs, rejectMsg, options): TimeoutRunner<T>

• constructor

  Type Parameters

  • T

  Parameters

  • maxMs: number

    number of milliseconds to allow tasks to run
  • rejectMsg: string

    message to reject with when timeout triggers
  • options: TimeoutRunnerOptions

    TimeoutRunnerOptions

  Returns TimeoutRunner<T>

ThePromise

TimeoutError

Optional error

maxMs

rejectMsg

Optional result

cancel

• cancel(msg?): void

• Cancel the operation and reject with msg

  Parameters

  • msg: string = "xaa TimeoutRunner operation cancelled"

    cancel message

  Returns void

clear

• clear(): void

• Explicitly clear the setTimeout handle

  Returns void

hasError

• hasError(): boolean

• check if runner has failed with error

  Returns boolean

  has error flag

hasResult

• hasResult(): boolean

• check if runner has finished with result

  Returns boolean

  has result flag

isDone

• isDone(): boolean

• Check if runner is done

  Returns boolean

  is done flag

run

• run<U>(tasks): Promise<T | T[]>

• Run tasks

  Type Parameters

  • U extends Tasks<T<T>> | Task<T>

  Parameters

  • tasks: U

    Promise or function that returns Promise, or array of them.

  Returns Promise<T | T[]>

  Promise to wait for tasks to complete, or timeout error.