Class WrappedSetMultiMap<TKey, TVal>

A SetMultiMap that uses an internal Map based on the provided constructor.

In case no input constructor is provided, the default Map implementation will be used.

It is required that the value type of this map is not Set or any extension of Set, otherwise the set and add functions wil break.

Type Parameters

  • TKey

  • TVal

Hierarchy

Implements

Constructors

constructor

Properties

[toStringTag] count map

Accessors

size

Methods

[iterator] add asMap clear delete deleteEntry distinctKeys entries entrySets forEach get has hasEntry keys set valueSets values

Constructors

constructor

  • Type Parameters

    • TKey

    • TVal

    Parameters

    • mapConstructor: (new () => Map<any, any>) = Map

      Will be used to instantiate the internal Map.

        • new (): Map<any, any>

        • Returns Map<any, any>

    • Optional iterable: Iterable<readonly [TKey, TVal | ReadonlySet<TVal>]>

      Entries to add to the map.

    Returns WrappedSetMultiMap<TKey, TVal>

Properties

Readonly [toStringTag]

[toStringTag]: "WrappedSetMultiMap" = 'WrappedSetMultiMap'

Private count

count: number

Private Readonly map

map: Map<TKey, Set<TVal>>

Accessors

size

Methods

[iterator]

  • [iterator](): IterableIterator<[TKey, TVal]>

  • Iterates over all key/value bindings in this Map.

    Returns IterableIterator<[TKey, TVal]>

add

asMap

  • Returns a Readonly Map representation of this Map.

    Returns ReadonlyMap<TKey, ReadonlySet<TVal>>

clear

delete

deleteEntry

  • Deletes the given key/value binding from the Map.

    Parameters

    • key: TKey
    • value: TVal

    Returns boolean

distinctKeys

  • Iterates over all distinct keys in this Map.

    Returns IterableIterator<TKey>

entries

  • Iterates over all key/value bindings in this Map.

    Returns IterableIterator<[TKey, TVal]>

entrySets

  • Iterates over all distinct keys in this Map, together with a Set of their values.

    Returns IterableIterator<[TKey, ReadonlySet<TVal>]>

forEach

  • Loops over all key/value bindings.

    Parameters

    • callbackfn: ((value: TVal, key: TKey, map: SetMultiMap<TKey, TVal>) => void)
        • (value: TVal, key: TKey, map: SetMultiMap<TKey, TVal>): void

        • Parameters

          Returns void

    • Optional thisArg: any

    Returns void

get

  • Returns all values stored for the given key. Returns undefined if there are no values for this key.

    Parameters

    • key: TKey

    Returns undefined | ReadonlySet<TVal>

has

hasEntry

  • Returns true if this key/value binding exists in the Map.

    Parameters

    • key: TKey
    • value: TVal

    Returns boolean

keys

set

valueSets

  • Iterates over all distinct keys and returns their Set of values.

    Returns IterableIterator<ReadonlySet<TVal>>

values

Settings

Member Visibility

Theme