Interface ConstMap<T, K, V>

Allows you to convert an object with specific member types into a Map that will give you the correct type for the correct member

interface ConstMap<
    T extends Partial<Record<keyof any, any>>,
    K extends keyof any = keyof T,
    V = T[keyof T],
> {
    "[toStringTag]": string;
    size: number;
    "[iterator]"(): MapIterator<[K, V]>;
    clear(): void;
    delete(key: K): boolean;
    entries(): MapIterator<[K, V]>;
    forEach(
        callbackfn: (value: V, key: K, map: Map<K, V>) => void,
        thisArg?: any,
    ): void;
    get<TK extends string | number | symbol>(key: TK): T[TK];
    get(key: K): V;
    has(key: K | keyof T): boolean;
    keys(): MapIterator<K>;
    set<TK extends string | number | symbol>(key: TK, value: T[TK]): this;
    set(key: K, value: V): this;
    values(): MapIterator<V>;
}

Type Parameters

  • T extends Partial<Record<keyof any, any>>
  • K extends keyof any = keyof T
  • V = T[keyof T]

Hierarchy

  • Map<K, V>
    • ConstMap

Properties

[toStringTag] size

Methods

[iterator] clear delete entries forEach get has keys set values

Properties

Readonly[toStringTag]

"[toStringTag]": string

Readonlysize

size: number

Returns

the number of elements in the Map.

Methods

[iterator]

  • "[iterator]"(): MapIterator<[K, V]>

    Returns an iterable of entries in the map.

    Returns MapIterator<[K, V]>

clear

  • clear(): void

    Returns void

delete

  • delete(key: K): boolean

    Parameters

    • key: K

    Returns boolean

    true if an element in the Map existed and has been removed, or false if the element does not exist.

entries

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

    Returns an iterable of key, value pairs for every entry in the map.

    Returns MapIterator<[K, V]>

forEach

  • forEach(
        callbackfn: (value: V, key: K, map: Map<K, V>) => void,
        thisArg?: any,
    ): void

    Executes a provided function once per each key/value pair in the Map, in insertion order.

    Parameters

    • callbackfn: (value: V, key: K, map: Map<K, V>) => void
    • OptionalthisArg: any

    Returns void

get

  • get<TK extends string | number | symbol>(key: TK): T[TK]

    Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.

    Type Parameters

    • TK extends string | number | symbol

    Parameters

    Returns T[TK]

    Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.

  • get(key: K): V

    Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.

    Parameters

    • key: K

    Returns V

    Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.

has

  • has(key: K | keyof T): boolean

    Parameters

    • key: K | keyof T

    Returns boolean

    boolean indicating whether an element with the specified key exists or not.

keys

  • keys(): MapIterator<K>

    Returns an iterable of keys in the map

    Returns MapIterator<K>

set

  • set<TK extends string | number | symbol>(key: TK, value: T[TK]): this

    Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated.

    Type Parameters

    • TK extends string | number | symbol

    Parameters

    Returns this

  • set(key: K, value: V): this

    Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated.

    Parameters

    • key: K
    • value: V

    Returns this

values

  • values(): MapIterator<V>

    Returns an iterable of values in the map

    Returns MapIterator<V>

Settings

Member Visibility

On This Page

Properties
Methods