Class AsyncProvider<T>

Async provider Allows a value to be provider asynchronously, with a timeout

Type Parameters

  • T = any

Hierarchy

  • AsyncProvider

Constructors

constructor

Properties

done error? onReject? onResolve? promise timeout? timeoutMs value?

Methods

getValue isDone provideError provideValue reset isTimeoutError

Constructors

constructor

Properties

Private done

done: boolean

Private Optional error

error?: Error

Private Optional onReject

onReject?: RejectFunc

Private Optional onResolve

onResolve?: ResolveFunc<T>

Private promise

promise: Promise<T>

Private Optional timeout

timeout?: number | Timeout

Private timeoutMs

timeoutMs: number

Private Optional value

value?: T

Methods

getValue

  • Obtains the provided value (Async) May throw if the timeout is reached or an error is provided

    Returns

    A promise for the provided value

    Returns Promise<T>

isDone

  • Checks if the provider is done

    Returns

    True if the value or error was already provided

    Returns boolean

provideError

  • Provides an error

    Parameters

    • error: Error

      The error

    Returns void

provideValue

  • Provides the value

    Parameters

    • value: T

      The value

    Returns void

reset

  • Resets the provider, setting it to the same status it was after constructing it

    Returns void

Static isTimeoutError

  • Checks if an error is a timeout error

    Returns

    True if the error is a timeout error

    Parameters

    • e: Error

      The error

    Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc