@umbraco-cms/backoffice
    Preparing search index...

    Class UmbArrayState<T, U, D>

    UmbArrayState

    • 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.

    Constructing with an actual array keeps the classic, non-nullable behaviour (getValue() returns T[]). Constructing with undefined — or a value typed to include undefined — makes the state nullable (getValue() returns T[] | undefined). Note this detection only works when the generic parameters aren't pinned explicitly to just T; to opt into the nullable behaviour while still naming T, provide all three generics: new UmbArrayState<Item, unknown, undefined>(undefined, ...).

    Type Parameters

    • T
    • U = unknown
    • D extends T[] | undefined = T[]

    Hierarchy (View Summary)

    Index
    constructor
    _subject getUniqueMethod
    value
    append appendOne appendOneAt asObservable asObservablePart clear destroy filter getHasOne getMutePromise getValue isMuted mute prepend remove removeOne replace setValue sortBy unmute updateOne

    Protected_subject

    _subject: BehaviorSubject<UmbArrayStateValue<T, D>>
    getUniqueMethod: (entry: T) => U
    • get value(): T

      Returns T

      Observable that

      • Holds the current data of this state.
      const myState = new UmbArrayState('Hello world');
      console.log("Value is: ", myState.value);
    • Function

      append

      Parameters

      • entries: T[]

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

      Returns UmbArrayState<T, U, D>

      Reference to it self.

      • Append some new data to this Subject, if it compares to existing data it will replace it.
      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'}
      ]);
    • Function

      appendOne

      Parameters

      • entry: T

        new data to be added in this Subject.

      Returns UmbArrayState<T, U, D>

      Reference to it self.

      • Append some new data to this Subject.
      const data = [
      	{ key: 1, value: 'foo'},
      	{ key: 2, value: 'bar'}
      ];
      const myState = new UmbArrayState(data);
      myState.append({ key: 1, value: 'replaced-foo'});
    • Function

      appendOneAt

      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, U, D>

      Reference to it self.

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

      asObservable

      Returns Observable<UmbArrayStateValue<T, D>>

      Observable that the State casts to.

      • Creates a new Observable with this State as the source. Observe this to subscribe to its value and future changes.
      const myState = new UmbArrayState('Hello world');

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

      clear

      Returns void

      • Set the data of this state to an empty array.
      const myState = new UmbArrayState(['Good morning']);
      // myState.value is equal ['Good morning'].
      myState.clear()
      // myState.value is equal [].
    • Function

      filter

      Parameters

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

        Method to determine which entries to keep.

      Returns UmbArrayState<T, U, D>

      Reference to it self.

      • 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'}
      ]
    • Function

      getHasOne

      Parameters

      • unique: U

        the unique value to compare with.

      Returns boolean

      Wether it existed

      • Check if a unique value exists in the current data of this Subject.
      const data = [
      	{ key: 1, value: 'foo'},
      	{ key: 2, value: 'bar'}
      ];
      const myState = new UmbArrayState(data, (x) => x.key);
      myState.hasOne(1);
    • Function

      getMutePromise

      Returns Promise<boolean>

      • Returns a promise which resolves to true if the state was muted and is now unmuted, or false if the state was not muted.
      • Get a promise which resolves when the mute is unset.
    • Function

      getValue

      Returns UmbArrayStateValue

      The current data of this state.

      • Provides the current data of this state.
      const myState = new UmbArrayState('Hello world');
      console.log("Value is: ", myState.value);
    • Function

      prepend

      Parameters

      • entries: T[]

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

      Returns UmbArrayState<T, U, D>

      Reference to it self.

      • Prepend some new data to this Subject, if it compares to existing data it will replace it.
      const data = [
      	{ key: 1, value: 'foo'},
      	{ key: 2, value: 'bar'}
      ];
      const myState = new UmbArrayState(data);
      myState.prepend([
      	{ key: 0, value: 'another-bla'},
      	{ key: 1, value: 'replaced-foo'},
      ]);
    • Function

      remove

      Parameters

      • uniques: U[]

        The unique values to remove.

      Returns UmbArrayState<T, U, D>

      Reference to it self.

      • 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]);
    • Function

      removeOne

      Parameters

      • unique: U

        The unique value to remove.

      Returns UmbArrayState<T, U, D>

      Reference to it self.

      • 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);
    • Function

      replace

      Parameters

      • entries: T[]

        data of entries to be replaced.

      Returns this

      Reference to it self.

      • Replaces one or more entries, requires the ArrayState to be constructed with a getUnique method.
      const data = [
      	{ key: 1, value: 'foo'},
      	{ key: 2, value: 'bar'}
      ];
      const myState = new UmbArrayState(data, (x) => x.key);
      const updates = [
      	{ key: 1, value: 'foo2'},
      	{ key: 3, value: 'bar2'}
      ];
      myState.replace(updates);
      // Only the existing item gets replaced:
      myState.getValue(); // -> [{ key: 1, value: 'foo2'}, { key: 2, value: 'bar'}]
    • Function

      setValue

      Parameters

      • value: UmbArrayStateValue<T, D>

        The next data for this state to hold.

      Returns void

      • 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.
      const myState = new UmbArrayState(['Good morning']);
      // myState.value is equal ['Good morning'].
      myState.setValue(['Goodnight'])
      // myState.value is equal ['Goodnight'].
    • Function

      sortBy

      Parameters

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

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

      Returns UmbArrayState<T, U, D>

      Reference to it self.

      • A sort method to this Subject.
      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));
    • Function

      updateOne

      Parameters

      • unique: U

        Unique value to find entry to update.

      • entry: Partial<T>

        new data to be added in this Subject.

      Returns UmbArrayState<T, U, D>

      Reference to it self.

      • Update a item with some new data, requires the ArrayState to be constructed with a getUnique method.
      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