interface OrderedMap<K,V>

A type-invariant immutable Ordered Map of key type K, and value type V. In the Map, each key has exactly one value, and the Map cannot contain duplicate keys. See the Map documentation and the OrderedMap API documentation

Companion namespace: OrderedMap

Extends: OrderedMapBase<K,V,Tp>

Implemented by: OrderedMap.NonEmpty<K,V>

Type parameters

Name	Description
K	the key type
V	the value type

note

• The OrderedMap keeps maintains the insertion order of elements, thus iterators and streams will also reflect this order. - The OrderedMap wraps around a Map instance, thus has mostly the same time complexity as the contained Map. - The OrderedMap keeps the key insertion order in a List, thus its space complexity is higher than a regular Map.

example

const m1 = OrderedHashMap.empty<number, string>()
const m2 = OrderedHashMap.of([1, 'a'], [2, 'b'])

Properties

keyOrder

Returns a List instance containing the key order of the Map.

Definition

readonly keyOrder: List<K>;

example

const m = OrderedHashMap.of([2, 'b'], [1, 'a'], [3, 'c'])
console.log(m.keyOrder.toArray())
// => [2, 1, 3]

Overrides

OrderedMapBase.keyOrder

sourceMap

Returns the contained Map instance.

Definition

readonly sourceMap: WithKeyValue<Tp, K, V>['sourceMap'];

example

const m = OrderedHashMap.of([2, 'b'], [1, 'a'])
console.log(m.sourceMap.toString())
// => HashMap(1 -> 'a', 2 -> 'b')

Overrides

OrderedMapBase.sourceMap