Interface IMapMutable<K, V>

A mutable map.

It is a wrapper around the in-built Map type, but adds roughly the same API as IMapImmutable.

interface IMapMutable<K, V> {
    add(...itemsToAdd: EitherKey<K, V>): void;
    clear(): void;
    delete(key: K): void;
    entries(): IterableIterator<readonly [K, V]>;
    get(key: K): undefined | V;
    has(key: K): boolean;
    isEmpty(): boolean;
    set(key: K, value: V): void;
    values(): IterableIterator<V>;
}

Type Parameters

  • K

    Type of map keys. Typically string

  • V

    Type of stored values

Hierarchy

  • IMapBase<K, V>
    • IMapMutable

Methods

add clear delete entries get has isEmpty set values

Methods

add

  • add(...itemsToAdd): void

  • Adds one or more items to map

    Can add items in the form of [key,value] or {key, value}.

    Parameters

    Returns void

    Example: These all produce the same result

    map.set(`hello`, `samantha`);
    map.add([`hello`, `samantha`]);
    map.add({key: `hello`, value: `samantha`})

clear

  • clear(): void

  • Clears map

    Returns void

delete

  • delete(key): void

  • Deletes an item by key

    Parameters

    • key: K

    Returns void

entries

  • entries(): IterableIterator<readonly [K, V]>

  • Iterates over entries (consisting of [key,value])

    Returns IterableIterator<readonly [K, V]>

    Example

    for (const [key, value] of map.entries()) {
     // Use key, value...
    }

get

  • get(key): undefined | V

  • Gets an item by key

    Parameters

    • key: K

    Returns undefined | V

    Example

    const item = map.get(`hello`);

has

  • has(key): boolean

  • Returns true if map contains key

    Parameters

    • key: K

    Returns boolean

    Example

    if (map.has(`hello`)) ...

isEmpty

  • isEmpty(): boolean

  • Returns true if map is empty

    Returns boolean

set

  • set(key, value): void

  • Sets a value to a specified key

    Parameters

    • key: K
    • value: V

    Returns void

values

  • values(): IterableIterator<V>

  • Returns IterableIterator<V>

Settings

Member Visibility

On This Page

Methods