Class default<T>

interface for disposable objects

Type Parameters

  • T

Hierarchy

Implements

Constructors

constructor

Properties

#postHandlers #preHandlers #timeout? #updatedEvent #updatingEvent #value

Accessors

value

Methods

#onUpdated #onUpdating dispose getValue setValue subscribe subscribeCore toPromise toString unsubscribe valueOf

Constructors

constructor

  • Creates a new PollingModelState

    Type Parameters

    • T

    Parameters

    • valueFactory: (() => T)

      can be a value factory

        • (): T

        • Returns T

    • timeout: number

    Returns default<T>

  • Creates a new PollingModelState

    Type Parameters

    • T

    Parameters

    • promiseFactory: (() => Promise<T>)

      can be a promise factory

        • (): Promise<T>

        • Returns Promise<T>

    • timeout: number

    Returns default<T>

  • Creates a new PollingModelState

    Type Parameters

    • T

    Parameters

    • promiseOrValueFactory: (() => Awaitable<T>)

      can be a promise or a value factory, a value or a promise that will be invoked immediately

    • timeout: number

    Returns default<T>

Properties

Private Readonly #postHandlers

#postHandlers: Record<string, EventHandler<Undefinable<T>>>

Private Readonly #preHandlers

#preHandlers: Record<string, EventHandler<Undefinable<T>>>

Private Optional #timeout

#timeout?: Timeout

Private Readonly #updatedEvent

#updatedEvent: default<Undefinable<T>>

Private Readonly #updatingEvent

#updatingEvent: default<Undefinable<T>>

Private #value

#value: Undefinable<T>

Accessors

value

Methods

Private Readonly #onUpdated

Private Readonly #onUpdating

dispose

Protected getValue

Protected setValue

subscribe

  • Creates a subscription to the ModelState that will be called when the state is updated.

    Parameters

    • postCallback: ((value) => void)
        • (value): void

        • Parameters

          Returns void

    • Optional preCallback: ((value) => void)
        • (value): void

        • Parameters

          Returns void

    Returns string

    A symbol that must saved to unsubscribe from the ModelState

Protected subscribeCore

  • Parameters

    • postCallback: ((value) => void)
        • (value): void

        • Parameters

          Returns void

    • Optional preCallback: ((value) => void)
        • (value): void

        • Parameters

          Returns void

    • publishCurrentValue: boolean = true

    Returns string

toPromise

toString

unsubscribe

valueOf

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc