Class Collection<KeyType, ValueType>

Collection-ish

Type Parameters

  • KeyType

  • ValueType

Hierarchy

  • Map<KeyType, ValueType>
    • Collection

Constructors

  • Type Parameters

    • KeyType

    • ValueType

    Parameters

    • Optional iterable: undefined

    Returns Collection<KeyType, ValueType>

Properties

[toStringTag]: string
size: number

Returns

the number of elements in the Map.

[species]: MapConstructor

Methods

  • Returns an iterable of entries in the map.

    Returns IterableIterator<[KeyType, ValueType]>

  • Returns void

  • Parameters

    • key: KeyType

    Returns boolean

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

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

    Returns IterableIterator<[KeyType, ValueType]>

  • Parameters

    • func: ((item) => boolean)
        • (item): boolean
        • Parameters

          • item: ValueType

          Returns boolean

    Returns undefined | ValueType

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

    Parameters

    • callbackfn: ((value, key, map) => void)
        • (value, key, map): void
        • Parameters

          • value: ValueType
          • key: KeyType
          • map: Map<KeyType, ValueType>

          Returns void

    • Optional thisArg: any

    Returns void

  • 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: KeyType

    Returns undefined | ValueType

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

  • Parameters

    • key: KeyType

    Returns boolean

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

  • Returns an iterable of keys in the map

    Returns IterableIterator<KeyType>

  • 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: KeyType
    • value: ValueType

    Returns Collection<KeyType, ValueType>

  • Returns an iterable of values in the map

    Returns IterableIterator<ValueType>

Generated using TypeDoc