Skip to content
Buy me a coffee

Map

Map: object

Defined in: src/immutable/ImmutableCollections.ts:786

Unmodifiable maps: null keys/values and null queries rejected, duplicate keys rejected; iteration order is unspecified.

Entry: object

Map.Entry statics: comparingByKey, comparingByValue, copyOf.

comparingByKey<K, V>(cmp?): (a, b) => number

Orders entries by key in natural order (null keys throw NullPointerException).

K

V

(a, b) => number

(a, b) => number

comparingByValue<K, V>(cmp?): (a, b) => number

Orders entries by value in natural order (null values throw NullPointerException).

K

V

(a, b) => number

(a, b) => number

copyOf<K, V>(e): MapEntry<K, V>

Unmodifiable, null-free copy of e (like Map.entry); returns e itself when it already is one.

K

V

MapEntry<K, V>

MapEntry<K, V>

NullPointerException if e, its key or its value is null

of: {<K, V>(): Map<K, V>; <K, V>(k1, v1): Map<K, V>; <K, V>(k1, v1, k2, v2): Map<K, V>; <K, V>(k1, v1, k2, v2, k3, v3): Map<K, V>; <K, V>(k1, v1, k2, v2, k3, v3, k4, v4): Map<K, V>; <K, V>(k1, v1, k2, v2, k3, v3, k4, v4, k5, v5): Map<K, V>; <K, V>(k1, v1, k2, v2, k3, v3, k4, v4, k5, v5, k6, v6): Map<K, V>; <K, V>(k1, v1, k2, v2, k3, v3, k4, v4, k5, v5, k6, v6, k7, v7): Map<K, V>; <K, V>(k1, v1, k2, v2, k3, v3, k4, v4, k5, v5, k6, v6, k7, v7, k8, v8): Map<K, V>; <K, V>(k1, v1, k2, v2, k3, v3, k4, v4, k5, v5, k6, v6, k7, v7, k8, v8, k9, v9): Map<K, V>; <K, V>(k1, v1, k2, v2, k3, v3, k4, v4, k5, v5, k6, v6, k7, v7, k8, v8, k9, v9, k10, v10): Map<K, V>; <K, V>(…keysAndValues): Map<K, V>; } = mapOf

Map.of(k1, v1, k2, v2, ...): returns an unmodifiable map of the key/value pairs. Iteration order is unspecified. Typed overloads cover up to 10 pairs; for more, prefer ofEntries.

<K, V>(): Map<K, V>

K

V

Map<K, V>

<K, V>(k1, v1): Map<K, V>

K

V

K

V

Map<K, V>

<K, V>(k1, v1, k2, v2): Map<K, V>

K

V

K

V

K

V

Map<K, V>

<K, V>(k1, v1, k2, v2, k3, v3): Map<K, V>

K

V

K

V

K

V

K

V

Map<K, V>

<K, V>(k1, v1, k2, v2, k3, v3, k4, v4): Map<K, V>

K

V

K

V

K

V

K

V

K

V

Map<K, V>

<K, V>(k1, v1, k2, v2, k3, v3, k4, v4, k5, v5): Map<K, V>

K

V

K

V

K

V

K

V

K

V

K

V

Map<K, V>

<K, V>(k1, v1, k2, v2, k3, v3, k4, v4, k5, v5, k6, v6): Map<K, V>

K

V

K

V

K

V

K

V

K

V

K

V

K

V

Map<K, V>

<K, V>(k1, v1, k2, v2, k3, v3, k4, v4, k5, v5, k6, v6, k7, v7): Map<K, V>

K

V

K

V

K

V

K

V

K

V

K

V

K

V

K

V

Map<K, V>

<K, V>(k1, v1, k2, v2, k3, v3, k4, v4, k5, v5, k6, v6, k7, v7, k8, v8): Map<K, V>

K

V

K

V

K

V

K

V

K

V

K

V

K

V

K

V

K

V

Map<K, V>

<K, V>(k1, v1, k2, v2, k3, v3, k4, v4, k5, v5, k6, v6, k7, v7, k8, v8, k9, v9): Map<K, V>

K

V

K

V

K

V

K

V

K

V

K

V

K

V

K

V

K

V

K

V

Map<K, V>

<K, V>(k1, v1, k2, v2, k3, v3, k4, v4, k5, v5, k6, v6, k7, v7, k8, v8, k9, v9, k10, v10): Map<K, V>

K

V

K

V

K

V

K

V

K

V

K

V

K

V

K

V

K

V

K

V

K

V

Map<K, V>

<K, V>(…keysAndValues): Map<K, V>

K

V

…[K, V, K, V, K, V, K, V, K, V, K, V, K, V, K, V, K, V, K, V, K, V, …(K | V)[]]

Map<K, V>

IllegalArgumentException on an odd argument count or a duplicate key

NullPointerException if a key or value is null or undefined

copyOf<K, V>(m): Map<K, V>

Returns an unmodifiable copy of m; iteration order is unspecified. Returns m itself when it already is a map made by Map.of, Map.ofEntries or Map.copyOf.

K

V

Map<K, V>

Map<K, V>

NullPointerException if m is null or holds a null or undefined key or value

entry<K, V>(k, v): MapEntry<K, V>

Returns an immutable entry, for use with ofEntries; setValue throws UnsupportedOperationException.

K

V

K

V

MapEntry<K, V>

NullPointerException if k or v is null or undefined

ofEntries<K, V>(…entries): Map<K, V>

Returns an unmodifiable map of the given entries (only their keys and values are copied). Iteration order is unspecified.

K

V

…MapEntry<K, V>[]

Map<K, V>

IllegalArgumentException on a duplicate key

NullPointerException if an entry, key or value is null or undefined

ofLazy<K, V>(keys, computingFunction): Map<K, V>

preview. Unmodifiable map with the given keys whose values are computed by computingFunction(key) on first access (get, getOrDefault, values/entrySet iteration, equals, hashCode, toString) and at most once per key. Failures behave as in List.ofLazy. Later changes to keys are not seen. get of a non-key is null; null queries throw NullPointerException.

K

V

Set<K>

(key) => V

Map<K, V>

NullPointerException if keys, one of them, or computingFunction is null