Class UmbArrayState<T>

UmbArrayState

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 ArrayState provides methods to append data when the data is an Object.

Type Parameters

  • T

Hierarchy (view full)

Constructors

constructor

Properties

_subject getUniqueMethod

Accessors

value

Methods

append appendOne appendOneAt asObservable asObservablePart destroy filter getMutePromise getValue isMuted mute remove removeOne setValue sortBy unmute updateOne

Constructors

constructor

Properties

Protected_subject

_subject: BehaviorSubject<T[]>

ReadonlygetUniqueMethod

getUniqueMethod: ((entry: T) => unknown)

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

append

  • append(entries): UmbArrayState<T>

  • Parameters

    • entries: T[]

      A array of new data to be added in this Subject.

    Returns UmbArrayState<T>

    Reference to it self.

    Function

    append

    Description

    • Append some new data to this Subject, if it compares to existing data it will replace it.

    Example: Example append some data.

    const data = [
    	{ key: 1, value: 'foo'},
    	{ key: 2, value: 'bar'}
    ];
    const myState = new UmbArrayState(data);
    myState.append([
    	{ key: 1, value: 'replaced-foo'},
    	{ key: 3, value: 'another-bla'}
    ]);

appendOne

  • appendOne(entry): UmbArrayState<T>

  • Parameters

    • entry: T

      new data to be added in this Subject.

    Returns UmbArrayState<T>

    Reference to it self.

    Function

    appendOne

    Description

    • Append some new data to this Subject.

    Example: Example append some data.

    const data = [
    	{ key: 1, value: 'foo'},
    	{ key: 2, value: 'bar'}
    ];
    const myState = new UmbArrayState(data);
    myState.append({ key: 1, value: 'replaced-foo'});

appendOneAt

  • appendOneAt(entry, index): UmbArrayState<T>

  • Parameters

    • entry: T

      new data to be added in this Subject.

    • index: number

      index of where to append this data into the Subject.

    Returns UmbArrayState<T>

    Reference to it self.

    Function

    appendOneAt

    Description

    • Append some new data to this Subject.

    Example: Example append some data.

    const data = [
    	{ key: 1, value: 'foo'},
    	{ key: 3, value: 'bar'}
    ];
    const myState = new UmbArrayState(data);
    myState.appendOneAt({ key: 2, value: 'in-between'}, 1);

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

filter

  • filter(predicate): UmbArrayState<T>

  • Parameters

    • predicate: ((value: T, index: number, array: T[]) => boolean)
        • (value, index, array): boolean

        • Parameters

          • value: T
          • index: number
          • array: T[]

          Returns boolean

    Returns UmbArrayState<T>

    Reference to it self.

    Function

    filter

    Description

    • Remove some new data of this Subject.

    Example: Example remove entry with key '1'

    const data = [
    	{ key: 1, value: 'foo'},
    	{ key: 2, value: 'bar'},
    	{ key: 3, value: 'poo'}
    ];
    const myState = new UmbArrayState(data, (x) => x.key);
    myState.filter((entry) => entry.key !== 1);

    Result:
     [
    		{ key: 2, value: 'bar'},
    		{ key: 3, value: 'poo'}
    ]

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

remove

  • remove(uniques): UmbArrayState<T>

  • Parameters

    • uniques: unknown[]

      The unique values to remove.

    Returns UmbArrayState<T>

    Reference to it self.

    Function

    remove

    Description

    • Remove some new data of this Subject.

    Example: Example remove entry with id '1' and '2'

    const data = [
    	{ id: 1, value: 'foo'},
    	{ id: 2, value: 'bar'}
    ];
    const myState = new UmbArrayState(data, (x) => x.id);
    myState.remove([1, 2]);

removeOne

  • removeOne(unique): UmbArrayState<T>

  • Parameters

    • unique: unknown

      The unique value to remove.

    Returns UmbArrayState<T>

    Reference to it self.

    Function

    removeOne

    Description

    • Remove some new data of this Subject.

    Example: Example remove entry with id '1'

    const data = [
    	{ id: 1, value: 'foo'},
    	{ id: 2, value: 'bar'}
    ];
    const myState = new UmbArrayState(data, (x) => x.id);
    myState.removeOne(1);

setValue

  • setValue(value): void

  • Parameters

    • value: T[]

    Returns void

    Function

    setValue

    Description

    • Set the data of this state, if sortBy has been defined for this state the data will be sorted before set. 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'.

sortBy

  • sortBy(sortMethod?): UmbArrayState<T>

  • Parameters

    • OptionalsortMethod: ((a: T, b: T) => number)

      A method to be used for sorting every time data is set.

        • (a, b): number

        • Parameters

          Returns number

    Returns UmbArrayState<T>

    Function

    sortBy

    Description

    • A sort method to this Subject.

    Example: Example add sort method

    const data = [
    	{ key: 1, value: 'foo'},
    	{ key: 2, value: 'bar'}
    ];
    const myState = new UmbArrayState(data, (x) => x.key);
    myState.sortBy((a, b) => (a.sortOrder || 0) - (b.sortOrder || 0));

unmute

updateOne

  • updateOne(unique, entry): UmbArrayState<T>

  • Parameters

    • unique: unknown

      Unique value to find entry to update.

    • entry: Partial<T>

      new data to be added in this Subject.

    Returns UmbArrayState<T>

    Reference to it self.

    Function

    updateOne

    Description

    • Update a item with some new data, requires the ArrayState to be constructed with a getUnique method.

    Example: Example append some data.

    const data = [
    	{ key: 1, value: 'foo'},
    	{ key: 2, value: 'bar'}
    ];
    const myState = new UmbArrayState(data, (x) => x.key);
    myState.updateOne(2, {value: 'updated-bar'});

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
""