Class Observable<T>

Observable is an implementation of a reactive value store.

// create the observerable with an initial value
const color = new Observerable("blue");

// subscribe an observer to listen for changes of `color.value`
color.subscribe((newColor: string) => console.log(newColor));

// changes to the value of color will be propagate onto all registered observers
color.value = "yellow";

// OUTPUT: "yellow"

Type Parameters

  • T

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

Properties

observers: ((state: T) => any)[] = []
state: T

Accessors

  • get value(): T
  • Returns T

  • set value(state: T): void
  • Parameters

    • state: T

    Returns void

Methods

  • Parameters

    • state: T

    Returns void

  • subscribe an observer to value changes

    Returns

    unsubscribe function for the given observer

    Parameters

    • observer: ((state: T) => any)

      the observer function to call upon value changes

        • (state: T): any
        • Parameters

          • state: T

          Returns any

    • options: { immediate: boolean } = ...

      use with { immediate: true } to call the observer with the current state immediately

      • immediate: boolean

    Returns (() => void)

      • (): void
      • subscribe an observer to value changes

        Returns

        unsubscribe function for the given observer

        Returns void

  • unsubscribe the given observer from the observerable

    Parameters

    • observer: ((state: T) => any)

      the observer to unsubscribe

        • (state: T): any
        • Parameters

          • state: T

          Returns any

    Returns void

Generated using TypeDoc