Class LockableMap<K, V>

A Map that can be permanently locked to prevent further mutations.

Before locking it behaves exactly like a regular Map. After lock() is called, any call to set, delete or clear throws immediately — enforcing immutability at the data-structure level.

Type Parameters

  • K
  • V

Hierarchy

  • Map<K, V>
    • LockableMap

Constructors

constructor

Properties

[toStringTag] size [species]

Accessors

locked

Methods

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

Constructors

constructor

Properties

Readonly[toStringTag]

[toStringTag]: string

Readonlysize

size: number

Returns

the number of elements in the Map.

Static Readonly[species]

[species]: MapConstructor

Accessors

locked

Methods

[iterator]

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

  • Returns an iterable of entries in the map.

    Returns MapIterator<[K, V]>

clear

delete

  • delete(key): 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, thisArg?): 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)
        • (value, key, map): void

        • Parameters

          • value: V
          • key: K
          • map: Map<K, V>

          Returns void

    • OptionalthisArg: any

    Returns void

get

  • get(key): undefined | 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 undefined | V

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

has

  • has(key): boolean

  • Parameters

    • key: K

    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>

lock

set

  • set(key, value): 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

Constructors
Properties
Accessors
Methods