Interface IMapOfMutable<V>

interface IMapOfMutable<V> {
    get isEmpty(): boolean;
    get lengthKeys(): number;
    addKeyedValues(key: string, ...values: readonly V[]): void;
    addValue(...values: readonly V[]): void;
    clear(): void;
    count(key: string): number;
    delete(key: string): boolean;
    deleteByValue(value: V): boolean;
    deleteKeyValue(key: string, value: V): boolean;
    entries(): IterableIterator<[key: string, value: V[]]>;
    entriesFlat(): IterableIterator<readonly [string, V]>;
    firstKeyByValue(value: V, eq?: IsEqual<V>): undefined | string;
    get(key: string): IterableIterator<V>;
    has(key: string): boolean;
    hasKeyValue(key: string, value: V, eq?: IsEqual<V>): boolean;
    keys(): IterableIterator<string>;
    keysAndCounts(): IterableIterator<readonly [string, number]>;
    valuesFlat(): IterableIterator<V>;
}

Type Parameters

  • V

Hierarchy (view full)

Implemented by

Accessors

isEmpty lengthKeys

Methods

addKeyedValues addValue clear count delete deleteByValue deleteKeyValue entries entriesFlat firstKeyByValue get has hasKeyValue keys keysAndCounts valuesFlat

Accessors

isEmpty

  • get isEmpty(): boolean

  • Returns true if the map is empty

    Returns boolean

lengthKeys

  • get lengthKeys(): number

  • Returns the number of keys

    Returns number

Methods

addKeyedValues

  • addKeyedValues(key, ...values): void

  • Adds several values under the same key. Duplicate values are permitted, depending on implementation.

    Parameters

    • key: string
    • Rest...values: readonly V[]

    Returns void

addValue

  • addValue(...values): void

  • Adds a value, automatically extracting a key via the groupBy function assigned in the constructor options.

    Parameters

    • Rest...values: readonly V[]

      Adds several values

    Returns void

clear

  • clear(): void

  • Clears the map

    Returns void

count

  • count(key): number

  • Returns the number of values stored under key, or 0 if key is not present.

    Parameters

    • key: string

      Key

    Returns number

delete

  • delete(key): boolean

  • Deletes all values stored under key. Returns true if key was found

    Parameters

    • key: string

    Returns boolean

deleteByValue

  • deleteByValue(value): boolean

  • Delete all occurrences of value, regardless of key it is stored under. Returns true if something was deleted.

    Parameters

    • value: V

    Returns boolean

deleteKeyValue

  • deleteKeyValue(key, value): boolean

  • Deletes all values under key that match value.

    Parameters

    • key: string

      Key

    • value: V

      Value

    Returns boolean

entries

  • entries(): IterableIterator<[key: string, value: V[]]>

  • Returns IterableIterator<[key: string, value: V[]]>

entriesFlat

  • entriesFlat(): IterableIterator<readonly [string, V]>

  • Iterates over key-value pairs. Unlike a normal map, the same key may appear several times.

    Returns IterableIterator<readonly [string, V]>

firstKeyByValue

  • firstKeyByValue(value, eq?): undefined | string

  • Finds the first key where value is stored. Note: value could be stored in multiple keys

    Parameters

    Returns undefined | string

    Key, or undefined if value not found

get

  • get(key): IterableIterator<V>

  • Iterates over all values stored under key

    Parameters

    • key: string

    Returns IterableIterator<V>

has

  • has(key): boolean

  • Returns true if key has any values

    Parameters

    • key: string

    Returns boolean

hasKeyValue

  • hasKeyValue(key, value, eq?): boolean

  • Returns true if value is stored under key.

    Parameters

    • key: string

      Key

    • value: V

      Value

    • Optionaleq: IsEqual<V>

    Returns boolean

keys

  • keys(): IterableIterator<string>

  • Iterates over all keys

    Returns IterableIterator<string>

keysAndCounts

  • keysAndCounts(): IterableIterator<readonly [string, number]>

  • Iteates over all keys and the count of values therein

    Returns IterableIterator<readonly [string, number]>

valuesFlat

  • valuesFlat(): IterableIterator<V>

  • Iterates over all values, regardless of key. Same value may re-appear if it's stored under different keys.

    Returns IterableIterator<V>

Settings

Member Visibility

On This Page

Accessors
Methods