Class UmbObjectState<T>

UmbObjectState

Description

  • A RxJS BehaviorSubject which deepFreezes the object-data to ensure its not manipulated from any implementations. Additionally the Subject ensures the data is unique, not updating any Observes unless there is an actual change of the content.

The UmbObjectState provides methods to append data when the data is an Object.

Type Parameters

  • T

Hierarchy (view full)

Constructors

constructor

Accessors

value

Methods

asObservable asObservablePart destroy getMutePromise getValue isMuted mute setValue unmute update

Constructors

constructor

Properties

Protected_subject

_subject: BehaviorSubject<T>

Accessors

value

  • get value(): T

  • Returns T

    Description

    • Holds the current data of this state.

    Example: Example retrieve the current data of a state

    const myState = new UmbArrayState('Hello world');
    console.log("Value is: ", myState.value);

Methods

asObservable

  • asObservable(): Observable<T>

  • Returns Observable<T>

    Observable that the State casts to.

    Function

    asObservable

    Description

    • Creates a new Observable with this State as the source. Observe this to subscribe to its value and future changes.

    Example: Example observe the data of a state

    const myState = new UmbArrayState('Hello world');

    this.observe(myState, (latestStateValue) => console.log("Value is: ", latestStateValue));

asObservablePart

destroy

getMutePromise

getValue

  • getValue(): T

  • Returns T

    The current data of this state.

    Function

    getValue

    Description

    • Provides the current data of this state.

    Example: Example retrieve the current data of a state

    const myState = new UmbArrayState('Hello world');
    console.log("Value is: ", myState.value);

isMuted

mute

setValue

unmute

update

  • update(partialData): UmbObjectState<T>

  • Parameters

    • partialData: Partial<T>

      A object containing some of the data to update in this Subject.

    Returns UmbObjectState<T>

    Reference to it self.

    Function

    update

    Description

    • Append some new data to this Object.

    Example: Example append some data.

    const data = {key: 'myKey', value: 'myInitialValue'};
    const myState = new UmbObjectState(data);
    myState.update({value: 'myNewValue'});

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
""