Class Future<T>

A class for handling dynamic values and tracking an error / loading state. Unlike a LoadingState this structure handles values that change, and can re-enter the loading state.

Type Parameters

  • T

Implements

Constructors

constructor

Properties

canLoad$ data$ empty$ error$ failed$ loading$ rawValue$ state$ value$ waiting$

Methods

subscribe

Constructors

constructor

  • new Future<T>(value$, loading$, error$, onLoad?, onDeleted?): Future<T>

  • Type Parameters

    • T

    Parameters

    • value$: Observable<undefined | T>
    • loading$: Observable<boolean>
    • error$: Observable<
          | undefined
          | string
          | boolean
          | Error>
    • OptionalonLoad: (() => void)
        • (): void

        • Returns void

    • OptionalonDeleted: (() => void)
        • (): void

        • Returns void

    Returns Future<T>

Properties

canLoad$

canLoad$: Observable<boolean>

Indicates if the future is in a state where the underlying request can be executed

data$

data$: Observable<undefined | T>

The value of Future if the future is in the Data state, otherwise undefined

empty$

empty$: Observable<boolean>

True if the Future is in the Empty state, otherwise false

error$

error$: Observable<undefined | Error>

The error given if the Future is in the Error state, otherwise undefined

failed$

failed$: Observable<boolean>

True if the Future is in the Error state, otherwise false

loading$

loading$: Observable<boolean>

True if the Future is in the Loading state, otherwise false

rawValue$

rawValue$: Observable<undefined | T>

The value of the Future if one is currently given, otherwise undefined

state$

state$: Observable<FutureUnion<T>>

The state of the Future

value$

value$: Observable<T>

The value of the Future. Won't emit until a value is present

waiting$

waiting$: Observable<boolean>

True if the Future is in the Loading or Empty state, otherwise false

Methods

subscribe

  • subscribe(observer): Unsubscribable

  • Parameters

    Returns Unsubscribable

Settings

Member Visibility

On This Page

Constructors
Properties
Methods