Class StateTracker

constructor

• new StateTracker(): StateTracker

• Returns StateTracker

Readonly Internal _tracker

onUpdate

• get onUpdate(): OnStateUpdate

• state updates sender.

  A state update will be sent to it whenever an update() function is called.

  The [OnEvent__symbol] property is an alias of this one.

  Returns OnStateUpdate

  State updates sender.

update

• get update(): (<T>(this, path, newValue, oldValue) => void)

• Updates the component state.

  All receivers registered with onUpdate will receive this update.

  Returns (<T>(this, path, newValue, oldValue) => void)

  • • <T>(this, path, newValue, oldValue): void

    • Updates the component state.

      All receivers registered with onUpdate will receive this update.

      Type Parameters

      • T

        A type of changed value.

      Parameters

      • this: void

      • path: StatePath

      • newValue: T

        New value.

      • oldValue: T

        Previous value.

      Returns void

[OnEvent__symbol]

• [OnEvent__symbol](): OnStateUpdate

• Returns an OnEvent instance of this event sender.

  Returns OnStateUpdate

  OnEvent instance registering event receivers sent by this sender.

done

• done(reason?): void

• Unregisters updates receivers and cuts off their supplies.

  After this method call the updates receivers of this partial state and all nested states won't receive any updates.

  Parameters

  • Optional reason: unknown

    An optional reason to stop tracking.

  Returns void

track

• track(path): StateTracker

• Starts tracking of partial state under the given path.

  Parameters

  • path: StatePath

    A path to state part.

  Returns StateTracker

  New partial state tracker.