Class UFMapOfSet<TKey, TValue>

UFMapOfSet can be used to store groups of unique values. It uses a Map that maps a value to a Set. The class takes care of managing the sets.

Type Parameters

  • TKey
  • TValue

Constructors

constructor

Accessors

keyCount valueTotalCount

Methods

add clear findKey get getKeys has hasValue isEmpty remove removeKey removeValue

Constructors

constructor

Accessors

keyCount

valueTotalCount

  • get valueTotalCount(): number

  • Gets the total number of value entries.

    Returns number

Methods

add

  • add(key, value): void

  • Adds a value to the group for a key. If the value is already available in the group, nothing changes.

    Parameters

    • key: TKey

      Key to add for

    • value: TValue

      Value to add to the group of aKey

    Returns void

clear

  • clear(): void

  • Clears the map and removes all keys and related sets.

    Returns void

findKey

  • findKey(value): null | TKey

  • Tries to the first key the value has been stored for.

    Parameters

    • value: TValue

      Value to find key

    Returns null | TKey

    the key or null if no key could be found.

get

  • get(key): TValue[]

  • Gets all values stored for a certain key.

    Parameters

    • key: TKey

      Key to get values for

    Returns TValue[]

    all values for the key or an empty array if the key does not exist.

getKeys

has

  • has(key): boolean

  • Checks if the map has a certain key.

    Parameters

    • key: TKey

      Key to check

    Returns boolean

    true if the map contains the key.

hasValue

  • hasValue(key, value): boolean

  • Checks if the instance has a certain value for a certain key.

    Parameters

    • key: TKey

      Key to check

    • value: TValue

      Value to check

    Returns boolean

    true if the map contains the key and value.

isEmpty

  • isEmpty(): boolean

  • Checks if the map contains any sets.

    Returns boolean

    true if there are no sets.

remove

  • remove(key, value): void

  • Removes a value from the group for a key.

    Parameters

    • key: TKey

      Key to remove for

    • value: TValue

      Value to remove from the group of key

    Returns void

removeKey

removeValue

  • removeValue(value): void

  • Searches for a key that contains the value and remove it.

    Parameters

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorkeyCountvalueTotalCountaddclearfindKeygetgetKeyshashasValueisEmptyremoveremoveKeyremoveValue