Class UmbStringState<T>

UmbStringState

Description

  • A state holding string data, this ensures the data is unique, not updating any Observes unless there is an actual change of the value, by using ===.

Type Parameters

  • T

Hierarchy (View Summary, Expand)

Constructors

constructor

Accessors

value

Methods

asObservable asObservablePart destroy getValue setValue

Constructors

constructor

Properties

Protected_subject

_subject: BehaviorSubject<string | T>

Accessors

value

  • get value(): T

    Returns T

    Observable that

    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<string | T>

    Returns Observable<string | 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

getValue

  • getValue(): string | T

    Returns string | 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);

setValue

  • setValue(data: string | T): void

    Parameters

    • data: string | T

      The next data for this state to hold.

    Returns void

    Function

    setValue

    Description

    • Set the data of this state, if data is different than current this will trigger observations to update.

    Example: Example change the data of a state

    const myState = new UmbArrayState('Good morning');
    // myState.value is equal 'Good morning'.
    myState.setValue('Goodnight')
    // myState.value is equal 'Goodnight'.

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
MMNEPVFCICPMFPCPTTAAATR