Interface Map

An immutable, unordered map of keys to values. Every change returns a new map and leaves the original untouched; a change that would not alter the map returns the same map. Keys are compared as is() does, so collections and records with equal values are the same key.

Interface

Type Parameters

Properties

size

Readonly

number

The number of entries in the map.

Methods

[iterator]

"[iterator]"(): IterableIterator<[K, V]>
Returns an iterator over the [key, value] pairs.

Returns
IterableIterator<[K, V]>
A new iterator.

butLast

butLast(): NutrientViewer.Immutable.Map<K, V>
Returns all entries but the last.

Returns
NutrientViewer.Immutable.Map<K, V>
A new map.

clear

clear(): NutrientViewer.Immutable.Map<K, V>
Removes every entry.

Returns
NutrientViewer.Immutable.Map<K, V>
An empty map, or this one when it is already empty.

concat

concat<KC, VC>(
...collections: Iterable<[KC, VC], any, any>[],
): NutrientViewer.Immutable.Map<K | KC, VC | Exclude<V, VC>>
An alias of merge.

Type Parameters
KC
VC
Parameters
...collectionsIterable<[KC, VC], any, any>[]
Collections of [key, value] pairs, or plain objects.

Returns
NutrientViewer.Immutable.Map<K | KC, VC | Exclude<V, VC>>
A new map, or this one when nothing is added.
concat<C>(
...collections: { [key: string]: C }[],
): NutrientViewer.Immutable.Map<string | K, C | Exclude<V, C>>
Type Parameters
C
Parameters
...collections{ [key: string]: C }[]
Returns
NutrientViewer.Immutable.Map<string | K, C | Exclude<V, C>>

contains

contains(value: V): boolean
An alias of includes.

Parameters
valueV
The value to look for.

Returns
boolean
true when an equal value is present.

count

count(): number
Returns the number of entries.

Returns
number
The size of the map.
count(
    predicate: (
        value: V,
        key: K,
        map: NutrientViewer.Immutable.Map<K, V>,
    ) => boolean,
    context?: unknown,
): number
Counts the entries the predicate accepts.

Parameters
predicate(value: V, key: K, map: NutrientViewer.Immutable.Map<K, V>) => boolean
Called with each value, its key and the map.

contextunknown
Optional
The this value for predicate.

Returns
number
The number of entries it returns truthy for.

countBy

countBy<G>(
    grouper: (
        value: V,
        key: K,
        map: NutrientViewer.Immutable.Map<K, V>,
    ) => G,
    context?: unknown,
): NutrientViewer.Immutable.Map<G, number>
Counts the entries per group.

Type Parameters
G
Parameters
grouper(value: V, key: K, map: NutrientViewer.Immutable.Map<K, V>) => G
Returns the group each entry is counted under.

contextunknown
Optional
The this value for grouper.

Returns
NutrientViewer.Immutable.Map<G, number>
A map from each group to how many entries produced it.

delete

delete(key: K): NutrientViewer.Immutable.Map<K, V>
Removes key.

Parameters
keyK
The key to remove.

Returns
NutrientViewer.Immutable.Map<K, V>
A new map, or this one when it has no such key.

deleteAll

deleteAll(keys: Iterable<K>): NutrientViewer.Immutable.Map<K, V>
Removes several keys.

Parameters
keysIterable<K>
The keys to remove.

Returns
NutrientViewer.Immutable.Map<K, V>
A new map, or this one when none of the keys is present.

deleteIn

deleteIn(keyPath: Iterable<unknown>): NutrientViewer.Immutable.Map<K, V>
Removes a key deep inside nested collections.

Parameters
keyPathIterable<unknown>
The keys to follow, from this map inwards.

Returns
NutrientViewer.Immutable.Map<K, V>
A new map, or this one when the path does not exist.

entries

entries(): IterableIterator<[K, V]>
Returns an iterator over the [key, value] pairs.

Returns
IterableIterator<[K, V]>
A new iterator.

equals

equals(other: unknown): boolean
Reports whether other is an unordered keyed collection, such as a map, holding equal keys and values, comparing as is() does.

Parameters
otherunknown
The value to compare against.

Returns
boolean
true when other is an unordered keyed collection with equal entries.

every

every<F>(
    predicate: (
        value: V,
        key: K,
        map: NutrientViewer.Immutable.Map<K, V>,
    ) => value is F,
    context?: unknown,
): this is NutrientViewer.Immutable.Map<K, F>
Reports whether the predicate accepts every entry, narrowing the collection to the type predicate guards.

Type Parameters
F
Parameters
predicate(value: V, key: K, map: NutrientViewer.Immutable.Map<K, V>) => value is F
Called with each value, its key and the map.

contextunknown
Optional
The this value for predicate.

Returns
this is NutrientViewer.Immutable.Map<K, F>
true when it returns truthy for every entry, and for an empty map.
every(
    predicate: (
        value: V,
        key: K,
        map: NutrientViewer.Immutable.Map<K, V>,
    ) => boolean,
    context?: unknown,
): boolean
Reports whether the predicate accepts every entry.

Parameters
predicate(value: V, key: K, map: NutrientViewer.Immutable.Map<K, V>) => boolean
Called with each value, its key and the map.

contextunknown
Optional
The this value for predicate.

Returns
boolean
true when it returns truthy for every entry, and for an empty map.

filter

filter<F>(
    predicate: (
        value: V,
        key: K,
        map: NutrientViewer.Immutable.Map<K, V>,
    ) => value is F,
    context?: unknown,
): NutrientViewer.Immutable.Map<K, F>
Returns the entries the predicate accepts.

Type Parameters
F
Parameters
predicate(value: V, key: K, map: NutrientViewer.Immutable.Map<K, V>) => value is F
Called with each value, its key and the map.

contextunknown
Optional
The this value for predicate.

Returns
NutrientViewer.Immutable.Map<K, F>
A new map.
filter(
    predicate: (
        value: V,
        key: K,
        map: NutrientViewer.Immutable.Map<K, V>,
    ) => unknown,
    context?: unknown,
): NutrientViewer.Immutable.Map<K, V>
Parameters
predicate(value: V, key: K, map: NutrientViewer.Immutable.Map<K, V>) => unknown
contextunknown
Optional
Returns
NutrientViewer.Immutable.Map<K, V>

filterNot

filterNot(
    predicate: (
        value: V,
        key: K,
        map: NutrientViewer.Immutable.Map<K, V>,
    ) => boolean,
    context?: unknown,
): NutrientViewer.Immutable.Map<K, V>
Returns the entries the predicate rejects.

Parameters
predicate(value: V, key: K, map: NutrientViewer.Immutable.Map<K, V>) => boolean
Called with each value, its key and the map.

contextunknown
Optional
The this value for predicate.

Returns
NutrientViewer.Immutable.Map<K, V>
A new map.

find

find<F>(
    predicate: (
        value: V,
        key: K,
        map: NutrientViewer.Immutable.Map<K, V>,
    ) => value is F,
    context?: unknown,
): F | undefined
Returns the first value the predicate accepts, narrowed to the type predicate guards.

Type Parameters
F
Parameters
predicate(value: V, key: K, map: NutrientViewer.Immutable.Map<K, V>) => value is F
Called with each value, its key and the map.

contextunknown
Optional
The this value for predicate.

Returns
F | undefined
The first accepted value, or undefined.
find<N>(
    predicate: (
        value: V,
        key: K,
        map: NutrientViewer.Immutable.Map<K, V>,
    ) => boolean,
    context: unknown,
    notSetValue: N,
): V | N
Returns the first value the predicate accepts.

Type Parameters
N
Parameters
predicate(value: V, key: K, map: NutrientViewer.Immutable.Map<K, V>) => boolean
Called with each value, its key and the map.

contextunknown
The this value for predicate.

notSetValueN
Returned when no value is accepted.

Returns
V | N
The first accepted value, or notSetValue.
find(
    predicate: (
        value: V,
        key: K,
        map: NutrientViewer.Immutable.Map<K, V>,
    ) => boolean,
    context?: unknown,
    notSetValue?: V,
): V | undefined
Returns the first value the predicate accepts.

Parameters
predicate(value: V, key: K, map: NutrientViewer.Immutable.Map<K, V>) => boolean
Called with each value, its key and the map.

contextunknown
Optional
The this value for predicate.

notSetValueV
Optional
Returned when no value is accepted.

Returns
V | undefined
The first accepted value, or notSetValue.

findLast

findLast<F>(
    predicate: (
        value: V,
        key: K,
        map: NutrientViewer.Immutable.Map<K, V>,
    ) => value is F,
    context?: unknown,
): F | undefined
Returns the last value the predicate accepts, narrowed to the type predicate guards.

Type Parameters
F
Parameters
predicate(value: V, key: K, map: NutrientViewer.Immutable.Map<K, V>) => value is F
Called with each value, its key and the map.

contextunknown
Optional
The this value for predicate.

Returns
F | undefined
The last accepted value, or undefined.
findLast<N>(
    predicate: (
        value: V,
        key: K,
        map: NutrientViewer.Immutable.Map<K, V>,
    ) => boolean,
    context: unknown,
    notSetValue: N,
): V | N
Returns the last value the predicate accepts.

Type Parameters
N
Parameters
predicate(value: V, key: K, map: NutrientViewer.Immutable.Map<K, V>) => boolean
Called with each value, its key and the map.

contextunknown
The this value for predicate.

notSetValueN
Returned when no value is accepted.

Returns
V | N
The last accepted value, or notSetValue.
findLast(
    predicate: (
        value: V,
        key: K,
        map: NutrientViewer.Immutable.Map<K, V>,
    ) => boolean,
    context?: unknown,
    notSetValue?: V,
): V | undefined
Returns the last value the predicate accepts.

Parameters
predicate(value: V, key: K, map: NutrientViewer.Immutable.Map<K, V>) => boolean
Called with each value, its key and the map.

contextunknown
Optional
The this value for predicate.

notSetValueV
Optional
Returned when no value is accepted.

Returns
V | undefined
The last accepted value, or notSetValue.

findLastEntry

findLastEntry(
    predicate: (
        value: V,
        key: K,
        map: NutrientViewer.Immutable.Map<K, V>,
    ) => boolean,
    context?: unknown,
    notSetValue?: [K, V],
): [K, V] | undefined
Returns the last [key, value] pair the predicate accepts.

Parameters
predicate(value: V, key: K, map: NutrientViewer.Immutable.Map<K, V>) => boolean
Called with each value, its key and the map.

contextunknown
Optional
The this value for predicate.

notSetValue[K, V]
Optional
Returned when no value is accepted.

Returns
[K, V] | undefined
The last accepted pair, or notSetValue.

findLastKey

findLastKey(
    predicate: (
        value: V,
        key: K,
        map: NutrientViewer.Immutable.Map<K, V>,
    ) => boolean,
    context?: unknown,
): K | undefined
Returns the key of the last entry the predicate accepts.

Parameters
predicate(value: V, key: K, map: NutrientViewer.Immutable.Map<K, V>) => boolean
Called with each value, its key and the map.

contextunknown
Optional
The this value for predicate.

Returns
K | undefined
The key, or undefined when no value is accepted.

first

first(): V | undefined
Returns the first value in iteration order.

Returns
V | undefined
The first value, or undefined for an empty map.
first<N>(notSetValue: N): V | N
Returns the first value in iteration order.

Type Parameters
N
Parameters
notSetValueN
Returned when the map is empty.

Returns
V | N
The first value, or notSetValue for an empty map.

flatMap

flatMap<KM, VM>(
    mapper: (
        value: V,
        key: K,
        map: NutrientViewer.Immutable.Map<K, V>,
    ) => Iterable<[KM, VM]>,
    context?: unknown,
): NutrientViewer.Immutable.Map<KM, VM>
Returns a map of the entries of the collections mapper returns.

Type Parameters
KM
VM
Parameters
mapper(
value: V,
key: K,
map: NutrientViewer.Immutable.Map<K, V>
) => Iterable<[KM, VM]>
Called with each value, its key and the map.

contextunknown
Optional
The this value for mapper.

Returns
NutrientViewer.Immutable.Map<KM, VM>
A new map. Entries that share a key keep the last value.

flatten

flatten(depth?: number): NutrientViewer.Immutable.Map<unknown, unknown>
Flattens nested collections, merging their entries by key.

Parameters
depthnumber
Optional
How many levels to flatten; omitted for all.

Returns
NutrientViewer.Immutable.Map<unknown, unknown>
A new map.
flatten(shallow?: boolean): NutrientViewer.Immutable.Map<unknown, unknown>
Flattens nested collections, merging their entries by key.

Parameters
shallowboolean
Optional
true to flatten one level; omitted or false for all.

Returns
NutrientViewer.Immutable.Map<unknown, unknown>
A new map.

flip

flip(): NutrientViewer.Immutable.Map<V, K>
Returns a map with keys and values swapped.

Returns
NutrientViewer.Immutable.Map<V, K>
A new map. Values that are equal keep the last key.

forEach

forEach(
    sideEffect: (
        value: V,
        key: K,
        map: NutrientViewer.Immutable.Map<K, V>,
    ) => unknown,
    context?: unknown,
): number
Calls sideEffect for each entry until it returns false.

Parameters
sideEffect(value: V, key: K, map: NutrientViewer.Immutable.Map<K, V>) => unknown
Called with each value, its key and the map.

contextunknown
Optional
The this value for sideEffect.

Returns
number
The number of entries visited, including the one that returned false.

get

get(key: K): V | undefined
Returns the value stored under key.

Parameters
keyK
The key to read.

Returns
V | undefined
The value, or undefined when the map has no such key.
get<N>(key: K, notSetValue: N): V | N
Returns the value stored under key.

Type Parameters
N
Parameters
keyK
The key to read.

notSetValueN
Returned when the map has no such key.

Returns
V | N
The value, or notSetValue when the map has no such key.

getIn

getIn(searchKeyPath: Iterable<unknown>, notSetValue?: unknown): unknown
Reads a value deep inside nested collections.

Parameters
searchKeyPathIterable<unknown>
The keys to follow, from this map inwards.

notSetValueunknown
Optional
Returned when the path does not exist.

Returns
unknown
The value at the path, or notSetValue.

groupBy

groupBy<G>(
    grouper: (
        value: V,
        key: K,
        map: NutrientViewer.Immutable.Map<K, V>,
    ) => G,
    context?: unknown,
): NutrientViewer.Immutable.Map<G, NutrientViewer.Immutable.Map<K, V>>
Groups the entries.

Type Parameters
G
Parameters
grouper(value: V, key: K, map: NutrientViewer.Immutable.Map<K, V>) => G
Returns the group each entry belongs to.

contextunknown
Optional
The this value for grouper.

Returns
NutrientViewer.Immutable.Map<G, NutrientViewer.Immutable.Map<K, V>>
A map from each group to a map of the entries that produced it.

has

has(key: K): boolean
Reports whether the map has key, even when its value is undefined.

Parameters
keyK
The key to look for.

Returns
boolean
true when the map has an entry for key.

hashCode

hashCode(): number
Computes a hash of this map from its contents, the same way Immutable.js does. Equal maps have equal hashes; maps with equal hashes are not necessarily equal. Plain objects, functions and symbols hash by identity, so a hash is only meaningful within the page that computed it.

Returns
number
An integer hash.

hasIn

hasIn(searchKeyPath: Iterable<unknown>): boolean
Reports whether a path exists inside nested collections.

Parameters
searchKeyPathIterable<unknown>
The keys to follow, from this map inwards.

Returns
boolean
true when every key on the path exists.

includes

includes(value: V): boolean
Reports whether the map holds a value equal to value, comparing as is() does.

Parameters
valueV
The value to look for.

Returns
boolean
true when an equal value is present.

isEmpty

isEmpty(): boolean
Reports whether the map has no entries.

Returns
boolean
true for an empty map.

isSubset

isSubset(iter: Iterable<V>): boolean
Reports whether every value of this map is in iter.

Parameters
iterIterable<V>
The values to look in.

Returns
boolean
true when each value of this map equals one in iter.

isSuperset

isSuperset(iter: Iterable<V>): boolean
Reports whether every value of iter is in this map.

Parameters
iterIterable<V>
The values to look for.

Returns
boolean
true when each value of iter equals one in this map.

join

join(separator?: string): string
Joins the values into a string.

Parameters
separatorstring
Optional
Placed between values; defaults to ,.

Returns
string
The joined string, with null and undefined as empty strings.

keyOf

keyOf(searchValue: V): K | undefined
Returns the key of the first entry whose value equals searchValue.

Parameters
searchValueV
The value to look for.

Returns
K | undefined
The key, or undefined when no value is equal.

keys

keys(): IterableIterator<K>
Returns an iterator over the keys.

Returns
IterableIterator<K>
A new iterator.

last

last(): V | undefined
Returns the last value in iteration order.

Returns
V | undefined
The last value, or undefined for an empty map.
last<N>(notSetValue: N): V | N
Returns the last value in iteration order.

Type Parameters
N
Parameters
notSetValueN
Returned when the map is empty.

Returns
V | N
The last value, or notSetValue for an empty map.

lastKeyOf

lastKeyOf(searchValue: V): K | undefined
Returns the key of the last entry whose value equals searchValue.

Parameters
searchValueV
The value to look for.

Returns
K | undefined
The key, or undefined when no value is equal.

map

map<M>(
mapper: (value: V, key: K, map: NutrientViewer.Immutable.Map<K, V>) => M,
context?: unknown,
): NutrientViewer.Immutable.Map<K, M>
Returns a map of the results of mapper, under the same keys.

Type Parameters
M
Parameters
mapper(value: V, key: K, map: NutrientViewer.Immutable.Map<K, V>) => M
Called with each value, its key and the map.

contextunknown
Optional
The this value for mapper.

Returns
NutrientViewer.Immutable.Map<K, M>
A new map, or this one when every result is the value it came from.

mapEntries

mapEntries<KM, VM>(
    mapper: (
        entry: [K, V],
        index: number,
        map: NutrientViewer.Immutable.Map<K, V>,
    ) => [KM, VM] | undefined,
    context?: unknown,
): NutrientViewer.Immutable.Map<KM, VM>
Returns a map with each entry replaced by the pair mapper returns.

Type Parameters
KM
VM
Parameters
mapper(
entry: [K, V],
index: number,
map: NutrientViewer.Immutable.Map<K, V>
) => [KM, VM] | undefined
Called with each [key, value] pair, its index and the map.

contextunknown
Optional
The this value for mapper.

Returns
NutrientViewer.Immutable.Map<KM, VM>
A new map. Pairs that share a key keep the last value; undefined results are skipped.

mapKeys

mapKeys<M>(
mapper: (key: K, value: V, map: NutrientViewer.Immutable.Map<K, V>) => M,
context?: unknown,
): NutrientViewer.Immutable.Map<M, V>
Returns a map with each key replaced by the result of mapper.

Type Parameters
M
Parameters
mapper(key: K, value: V, map: NutrientViewer.Immutable.Map<K, V>) => M
Called with each key, its value and the map.

contextunknown
Optional
The this value for mapper.

Returns
NutrientViewer.Immutable.Map<M, V>
A new map. Keys that map to the same result keep the last value.

max

max(comparator?: (a: V, b: V) => number): V | undefined
Returns the largest value.

Parameters
comparator(a: V, b: V) => number
Optional
Orders two values; defaults to < and >.

Returns
V | undefined
The largest value, or undefined for an empty map.

maxBy

maxBy<C>(
    comparatorValueMapper: (
        value: V,
        key: K,
        map: NutrientViewer.Immutable.Map<K, V>,
    ) => C,
    comparator?: (a: C, b: C) => number,
): V | undefined
Returns the value with the largest mapped key.

Type Parameters
C
Parameters
comparatorValueMapper(value: V, key: K, map: NutrientViewer.Immutable.Map<K, V>) => C
Maps each entry to the key to compare by.

comparator(a: C, b: C) => number
Optional
Orders two mapped keys; defaults to < and >.

Returns
V | undefined
The value, or undefined for an empty map.

merge

merge<KC, VC>(
...collections: Iterable<[KC, VC], any, any>[],
): NutrientViewer.Immutable.Map<K | KC, VC | Exclude<V, VC>>
Adds the entries of the collections, later ones replacing earlier ones.

Type Parameters
KC
VC
Parameters
...collectionsIterable<[KC, VC], any, any>[]
Collections of [key, value] pairs, or plain objects.

Returns
NutrientViewer.Immutable.Map<K | KC, VC | Exclude<V, VC>>
A new map, or this one when nothing is added.
merge<C>(
...collections: { [key: string]: C }[],
): NutrientViewer.Immutable.Map<string | K, C | Exclude<V, C>>
Type Parameters
C
Parameters
...collections{ [key: string]: C }[]
Returns
NutrientViewer.Immutable.Map<string | K, C | Exclude<V, C>>

mergeDeep

mergeDeep<KC, VC>(
...collections: Iterable<[KC, VC], any, any>[],
): NutrientViewer.Immutable.Map<K | KC, V | VC>
Adds the entries of the collections, merging collections found under the same key.

Type Parameters
KC
VC
Parameters
...collectionsIterable<[KC, VC], any, any>[]
Collections of [key, value] pairs, or plain objects.

Returns
NutrientViewer.Immutable.Map<K | KC, V | VC>
A new map, or this one when nothing changes.
mergeDeep<C>(
...collections: { [key: string]: C }[],
): NutrientViewer.Immutable.Map<string | K, V | C>
Type Parameters
C
Parameters
...collections{ [key: string]: C }[]
Returns
NutrientViewer.Immutable.Map<string | K, V | C>

mergeDeepIn

mergeDeepIn(
keyPath: Iterable<unknown>,
...collections: unknown[],
): NutrientViewer.Immutable.Map<K, V>
Deeply merges collections into the map found at a path, creating it when missing.

Parameters
keyPathIterable<unknown>
The keys to follow, from this map inwards.

...collectionsunknown[]
The collections to merge in.

Returns
NutrientViewer.Immutable.Map<K, V>
A new map, or this one when nothing changes.

mergeDeepWith

mergeDeepWith(
merger: (oldVal: unknown, newVal: unknown, key: unknown) => unknown,
...collections: (Iterable<[K, V], any, any> | { [key: string]: V })[],
): NutrientViewer.Immutable.Map<K, V>
Adds the entries of the collections, merging collections found under the same key and combining other values with merger.

Parameters
merger(oldVal: unknown, newVal: unknown, key: unknown) => unknown
Returns the value to keep from the existing value, the new value and the key.

...collections(Iterable<[K, V], any, any> | { [key: string]: V })[]
Collections of [key, value] pairs, or plain objects.

Returns
NutrientViewer.Immutable.Map<K, V>
A new map, or this one when nothing changes.

mergeIn

mergeIn(
keyPath: Iterable<unknown>,
...collections: unknown[],
): NutrientViewer.Immutable.Map<K, V>
Merges collections into the map found at a path, creating it when missing.

Parameters
keyPathIterable<unknown>
The keys to follow, from this map inwards.

...collectionsunknown[]
The collections to merge in.

Returns
NutrientViewer.Immutable.Map<K, V>
A new map, or this one when nothing changes.

mergeWith

mergeWith<KC, VC, VCC>(
merger: (oldVal: V, newVal: VC, key: K) => VCC,
...collections: Iterable<[KC, VC], any, any>[],
): NutrientViewer.Immutable.Map<K | KC, V | VC | VCC>
Adds the entries of the collections, combining values under a key both have.

Type Parameters
KC
VC
VCC
Parameters
merger(oldVal: V, newVal: VC, key: K) => VCC
Returns the value to keep from the existing value, the new value and the key.

...collectionsIterable<[KC, VC], any, any>[]
Collections of [key, value] pairs, or plain objects.

Returns
NutrientViewer.Immutable.Map<K | KC, V | VC | VCC>
A new map, or this one when nothing changes.
mergeWith<C, CC>(
merger: (oldVal: V, newVal: C, key: string) => CC,
...collections: { [key: string]: C }[],
): NutrientViewer.Immutable.Map<string | K, V | C | CC>
Type Parameters
C
CC
Parameters
merger(oldVal: V, newVal: C, key: string) => CC
...collections{ [key: string]: C }[]
Returns
NutrientViewer.Immutable.Map<string | K, V | C | CC>

min

min(comparator?: (a: V, b: V) => number): V | undefined
Returns the smallest value.

Parameters
comparator(a: V, b: V) => number
Optional
Orders two values; defaults to < and >.

Returns
V | undefined
The smallest value, or undefined for an empty map.

minBy

minBy<C>(
    comparatorValueMapper: (
        value: V,
        key: K,
        map: NutrientViewer.Immutable.Map<K, V>,
    ) => C,
    comparator?: (a: C, b: C) => number,
): V | undefined
Returns the value with the smallest mapped key.

Type Parameters
C
Parameters
comparatorValueMapper(value: V, key: K, map: NutrientViewer.Immutable.Map<K, V>) => C
Maps each entry to the key to compare by.

comparator(a: C, b: C) => number
Optional
Orders two mapped keys; defaults to < and >.

Returns
V | undefined
The value, or undefined for an empty map.

partition

partition<F, C>(
    predicate: (
        this: C,
        value: V,
        key: K,
        map: NutrientViewer.Immutable.Map<K, V>,
    ) => value is F,
    context?: C,
): [NutrientViewer.Immutable.Map<K, V>, NutrientViewer.Immutable.Map<K, F>]
Splits the entries into those the predicate rejects and those it accepts.

Type Parameters
F
C
Parameters
predicate(
this: C,
value: V,
key: K,
map: NutrientViewer.Immutable.Map<K, V>
) => value is F
Called with each value, its key and the map.

contextC
Optional
The this value for predicate.

Returns
[NutrientViewer.Immutable.Map<K, V>, NutrientViewer.Immutable.Map<K, F>]
A pair of maps: the rejected entries, then the accepted entries.
partition<C>(
    predicate: (
        this: C,
        value: V,
        key: K,
        map: NutrientViewer.Immutable.Map<K, V>,
    ) => unknown,
    context?: C,
): [NutrientViewer.Immutable.Map<K, V>, NutrientViewer.Immutable.Map<K, V>]
Type Parameters
C
Parameters
predicate(this: C, value: V, key: K, map: NutrientViewer.Immutable.Map<K, V>) => unknown
contextC
Optional
Returns
[NutrientViewer.Immutable.Map<K, V>, NutrientViewer.Immutable.Map<K, V>]

reduce

reduce(
    reducer: (
        reduction: V,
        value: V,
        key: K,
        map: NutrientViewer.Immutable.Map<K, V>,
    ) => V,
): V
Reduces the values to one, starting from the first value.

Parameters
reducer(reduction: V, value: V, key: K, map: NutrientViewer.Immutable.Map<K, V>) => V
Called with the running result, each later value, its key and the map.

Returns
V
The reduced value, or undefined for an empty map.
reduce<R>(
    reducer: (
        reduction: R,
        value: V,
        key: K,
        map: NutrientViewer.Immutable.Map<K, V>,
    ) => R,
    initialReduction: R,
    context?: unknown,
): R
Reduces the values to one.

Type Parameters
R
Parameters
reducer(reduction: R, value: V, key: K, map: NutrientViewer.Immutable.Map<K, V>) => R
Called with the running result, each value, its key and the map.

initialReductionR
The starting result.

contextunknown
Optional
The this value for reducer.

Returns
R
The reduced value.
reduce<R>(
    reducer: (
        reduction: V | R,
        value: V,
        key: K,
        map: NutrientViewer.Immutable.Map<K, V>,
    ) => R,
): R
Type Parameters
R
Parameters
reducer(
reduction: V | R,
value: V,
key: K,
map: NutrientViewer.Immutable.Map<K, V>
) => R
Returns
R

reduceRight

reduceRight(
    reducer: (
        reduction: V,
        value: V,
        key: K,
        map: NutrientViewer.Immutable.Map<K, V>,
    ) => V,
): V
Reduces the values to one, from the last value to the first, starting from the last value.

Parameters
reducer(reduction: V, value: V, key: K, map: NutrientViewer.Immutable.Map<K, V>) => V
Called with the running result, each earlier value, its key and the map.

Returns
V
The reduced value, or undefined for an empty map.
reduceRight<R>(
    reducer: (
        reduction: R,
        value: V,
        key: K,
        map: NutrientViewer.Immutable.Map<K, V>,
    ) => R,
    initialReduction: R,
    context?: unknown,
): R
Reduces the values to one, from the last value to the first.

Type Parameters
R
Parameters
reducer(reduction: R, value: V, key: K, map: NutrientViewer.Immutable.Map<K, V>) => R
Called with the running result, each value, its key and the map.

initialReductionR
The starting result.

contextunknown
Optional
The this value for reducer.

Returns
R
The reduced value.
reduceRight<R>(
    reducer: (
        reduction: V | R,
        value: V,
        key: K,
        map: NutrientViewer.Immutable.Map<K, V>,
    ) => R,
): R
Type Parameters
R
Parameters
reducer(
reduction: V | R,
value: V,
key: K,
map: NutrientViewer.Immutable.Map<K, V>
) => R
Returns
R

remove

remove(key: K): NutrientViewer.Immutable.Map<K, V>
An alias of delete.

Parameters
keyK
The key to remove.

Returns
NutrientViewer.Immutable.Map<K, V>
A new map, or this one when it has no such key.

removeAll

removeAll(keys: Iterable<K>): NutrientViewer.Immutable.Map<K, V>
An alias of deleteAll.

Parameters
keysIterable<K>
The keys to remove.

Returns
NutrientViewer.Immutable.Map<K, V>
A new map, or this one when none of the keys is present.

removeIn

removeIn(keyPath: Iterable<unknown>): NutrientViewer.Immutable.Map<K, V>
An alias of deleteIn.

Parameters
keyPathIterable<unknown>
The keys to follow, from this map inwards.

Returns
NutrientViewer.Immutable.Map<K, V>
A new map, or this one when the path does not exist.

rest

rest(): NutrientViewer.Immutable.Map<K, V>
Returns all entries but the first.

Returns
NutrientViewer.Immutable.Map<K, V>
A new map.

reverse

reverse(): NutrientViewer.Immutable.Map<K, V>
Returns the entries in reverse iteration order.

Returns
NutrientViewer.Immutable.Map<K, V>
A new map.

set

set(key: K, value: V): NutrientViewer.Immutable.Map<K, V>
Sets the value stored under key.

Parameters
keyK
The key to set.

valueV
The value to store.

Returns
NutrientViewer.Immutable.Map<K, V>
A new map, or this one when key already holds value.

setIn

setIn(
keyPath: Iterable<unknown>,
value: unknown,
): NutrientViewer.Immutable.Map<K, V>
Sets a value deep inside nested collections, creating maps for missing keys.

Parameters
keyPathIterable<unknown>
The keys to follow, from this map inwards.

valueunknown
The value to store.

Returns
NutrientViewer.Immutable.Map<K, V>
A new map, or this one when the path already holds value.

skip

skip(amount: number): NutrientViewer.Immutable.Map<K, V>
Returns the entries after the first amount.

Parameters
amountnumber
How many entries to skip.

Returns
NutrientViewer.Immutable.Map<K, V>
A new map.

skipLast

skipLast(amount: number): NutrientViewer.Immutable.Map<K, V>
Returns the entries before the last amount.

Parameters
amountnumber
How many entries to skip from the end.

Returns
NutrientViewer.Immutable.Map<K, V>
A new map.

skipUntil

skipUntil(
    predicate: (
        value: V,
        key: K,
        map: NutrientViewer.Immutable.Map<K, V>,
    ) => boolean,
    context?: unknown,
): NutrientViewer.Immutable.Map<K, V>
Returns the entries from the first one the predicate accepts.

Parameters
predicate(value: V, key: K, map: NutrientViewer.Immutable.Map<K, V>) => boolean
Called with each value, its key and the map.

contextunknown
Optional
The this value for predicate.

Returns
NutrientViewer.Immutable.Map<K, V>
A new map.

skipWhile

skipWhile(
    predicate: (
        value: V,
        key: K,
        map: NutrientViewer.Immutable.Map<K, V>,
    ) => boolean,
    context?: unknown,
): NutrientViewer.Immutable.Map<K, V>
Returns the entries from the first one the predicate rejects.

Parameters
predicate(value: V, key: K, map: NutrientViewer.Immutable.Map<K, V>) => boolean
Called with each value, its key and the map.

contextunknown
Optional
The this value for predicate.

Returns
NutrientViewer.Immutable.Map<K, V>
A new map.

slice

slice(begin?: number, end?: number): NutrientViewer.Immutable.Map<K, V>
Returns the entries from begin up to, not including, end, in iteration order. A negative index counts from the end.

Parameters
beginnumber
Optional
The first position to keep; defaults to the start.

endnumber
Optional
The position to stop before; defaults to the end.

Returns
NutrientViewer.Immutable.Map<K, V>
A new map, or this one when begin is given and the range covers every entry.

some

some(
    predicate: (
        value: V,
        key: K,
        map: NutrientViewer.Immutable.Map<K, V>,
    ) => boolean,
    context?: unknown,
): boolean
Reports whether the predicate accepts any entry.

Parameters
predicate(value: V, key: K, map: NutrientViewer.Immutable.Map<K, V>) => boolean
Called with each value, its key and the map.

contextunknown
Optional
The this value for predicate.

Returns
boolean
true when it returns truthy for at least one entry.

sort

sort(comparator?: (a: V, b: V) => number): OrderedMap<K, V>
Returns the entries sorted by value. The sort is stable.

Parameters
comparator(a: V, b: V) => number
Optional
Orders two values; defaults to < and >, with undefined last.

Returns
OrderedMap<K, V>
A new ordered map.

sortBy

sortBy<C>(
    comparatorValueMapper: (
        value: V,
        key: K,
        map: NutrientViewer.Immutable.Map<K, V>,
    ) => C,
    comparator?: (a: C, b: C) => number,
): OrderedMap<K, V>
Returns the entries sorted by a mapped key. The sort is stable.

Type Parameters
C
Parameters
comparatorValueMapper(value: V, key: K, map: NutrientViewer.Immutable.Map<K, V>) => C
Maps each entry to the key to sort by.

comparator(a: C, b: C) => number
Optional
Orders two keys; defaults to < and >, with undefined last.

Returns
OrderedMap<K, V>
A new ordered map.

take

take(amount: number): NutrientViewer.Immutable.Map<K, V>
Returns the first amount entries.

Parameters
amountnumber
How many entries to keep.

Returns
NutrientViewer.Immutable.Map<K, V>
A new map.

takeLast

takeLast(amount: number): NutrientViewer.Immutable.Map<K, V>
Returns the last amount entries.

Parameters
amountnumber
How many entries to keep.

Returns
NutrientViewer.Immutable.Map<K, V>
A new map.

takeUntil

takeUntil(
    predicate: (
        value: V,
        key: K,
        map: NutrientViewer.Immutable.Map<K, V>,
    ) => boolean,
    context?: unknown,
): NutrientViewer.Immutable.Map<K, V>
Returns the entries before the first one the predicate accepts.

Parameters
predicate(value: V, key: K, map: NutrientViewer.Immutable.Map<K, V>) => boolean
Called with each value, its key and the map.

contextunknown
Optional
The this value for predicate.

Returns
NutrientViewer.Immutable.Map<K, V>
A new map.

takeWhile

takeWhile(
    predicate: (
        value: V,
        key: K,
        map: NutrientViewer.Immutable.Map<K, V>,
    ) => boolean,
    context?: unknown,
): NutrientViewer.Immutable.Map<K, V>
Returns the entries before the first one the predicate rejects.

Parameters
predicate(value: V, key: K, map: NutrientViewer.Immutable.Map<K, V>) => boolean
Called with each value, its key and the map.

contextunknown
Optional
The this value for predicate.

Returns
NutrientViewer.Immutable.Map<K, V>
A new map.

toArray

toArray(): [K, V][]
Converts the map to an array of [key, value] pairs.

Returns
[K, V][]
A new array.

toJS

toJS(): PlainObjectOf<V>
Converts the map to plain values all the way down: nested collections, records, arrays and plain objects become plain arrays and objects.

Returns
PlainObjectOf<V>
A new plain object.

toJSON

toJSON(): { [key: string]: V; [key: number]: V; [key: symbol]: V }
Converts the map to an object, leaving nested collections as they are, for JSON.stringify.

Returns
{ [key: string]: V; [key: number]: V; [key: symbol]: V }
A new object.

toList

toList(): NutrientViewer.Immutable.List<V>
Converts the map to a list of its values.

Returns
NutrientViewer.Immutable.List<V>
A new list.

toMap

toMap(): NutrientViewer.Immutable.Map<K, V>
Copies the map.

Returns
NutrientViewer.Immutable.Map<K, V>
A new map with the same entries.

toObject

toObject(): { [key: string]: V }
Converts the map to an object, leaving nested collections as they are. Keys become strings.

Returns
{ [key: string]: V }
A new object.

toOrderedMap

toOrderedMap(): OrderedMap<K, V>
Converts the map to an ordered map with the same iteration order.

Returns
OrderedMap<K, V>
A new ordered map.

toOrderedSet

toOrderedSet(): OrderedSet<V>
Converts the map to an ordered set of its values, dropping duplicates.

Returns
OrderedSet<V>
A new ordered set.

toSet

toSet(): NutrientViewer.Immutable.Set<V>
Converts the map to a set of its values, dropping duplicates.

Returns
NutrientViewer.Immutable.Set<V>
A new set.

toString

toString(): string
Prints the map, for example Map { "a": 1 }.

Returns
string
The printed map.

update

update(
    key: K,
    notSetValue: V,
    updater: (value: V) => V,
): NutrientViewer.Immutable.Map<K, V>
Replaces the value under key with the result of updater.

Parameters
keyK
The key to update.

notSetValueV
Passed to updater when the map has no such key.

updater(value: V) => V
Returns the new value from the current one.

Returns
NutrientViewer.Immutable.Map<K, V>
A new map, or this one when updater returns its argument.
update(
key: K,
updater: (value: V | undefined) => V | undefined,
): NutrientViewer.Immutable.Map<K, V>
Replaces the value under key with the result of updater.

Parameters
keyK
The key to update.

updater(value: V | undefined) => V | undefined
Returns the new value from the current one, which is undefined when the map has no such key.

Returns
NutrientViewer.Immutable.Map<K, V>
A new map, or this one when updater returns its argument.
update<R>(updater: (value: NutrientViewer.Immutable.Map<K, V>) => R): R
Passes the map to updater and returns its result.

Type Parameters
R
Parameters
updater(value: NutrientViewer.Immutable.Map<K, V>) => R
Called once with this map.

Returns
R
Whatever updater returns.

updateIn

updateIn(
    keyPath: Iterable<unknown>,
    notSetValue: unknown,
    updater: (value: unknown) => unknown,
): NutrientViewer.Immutable.Map<K, V>
Replaces a value deep inside nested collections with the result of updater.

Parameters
keyPathIterable<unknown>
The keys to follow, from this map inwards.

notSetValueunknown
Passed to updater when the path does not exist.

updater(value: unknown) => unknown
Returns the new value from the current one.

Returns
NutrientViewer.Immutable.Map<K, V>
A new map, or this one when updater returns its argument.
updateIn(
keyPath: Iterable<unknown>,
updater: (value: unknown) => unknown,
): NutrientViewer.Immutable.Map<K, V>
Parameters
keyPathIterable<unknown>
updater(value: unknown) => unknown
Returns
NutrientViewer.Immutable.Map<K, V>

values

values(): IterableIterator<V>
Returns an iterator over the values.

Returns
IterableIterator<V>
A new iterator.

withMutations

withMutations(
mutator: (mutable: NutrientViewer.Immutable.Map<K, V>) => unknown,
): NutrientViewer.Immutable.Map<K, V>
Applies several changes in one batch. The mutator receives a draft map whose changing methods modify it in place and return it.

Parameters
mutator(mutable: NutrientViewer.Immutable.Map<K, V>) => unknown
Called once with the draft.

Returns
NutrientViewer.Immutable.Map<K, V>
A new map holding the changes, or this one when the mutator changed nothing.

Interface Map

Type Parameters

Properties

Methods

Returns

Returns

Returns

Type Parameters

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Type Parameters

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Type Parameters

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Type Parameters

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Type Parameters

Parameters