Interface List

An immutable, ordered list of values. Every change returns a new list and leaves the original untouched; a change that would not alter the list returns the same list.

Interface

Type Parameters

Properties

size

Readonly

number

The number of values in the list.

Methods

[iterator]

"[iterator]"(): IterableIterator<T>
Iterates the values in order.

Returns
IterableIterator<T>
An iterator of each value.

butLast

butLast(): NutrientViewer.Immutable.List<T>
Returns the list without its last value.

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

clear

clear(): NutrientViewer.Immutable.List<T>
Returns an empty list.

Returns
NutrientViewer.Immutable.List<T>
A new empty list, or this one when it is already empty.

concat

concat<C>(
...valuesOrCollections: (C | Iterable<C, any, any>)[],
): NutrientViewer.Immutable.List<T | C>
Returns the list followed by the values and collections given. A string, or a value that is not iterable, is added as one value.

Type Parameters
C
Parameters
...valuesOrCollections(C | Iterable<C, any, any>)[]
The values to add, or collections whose values to add.

Returns
NutrientViewer.Immutable.List<T | C>
A new list, or this one when nothing is added.

contains

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

Parameters
valueT
The value to look for.

Returns
boolean
true when an equal value is present.

count

count(): number
Counts the values.

Returns
number
The number of values.
count(
    predicate: (
        value: T,
        index: number,
        list: NutrientViewer.Immutable.List<T>,
    ) => boolean,
    context?: unknown,
): number
Counts the values the predicate accepts.

Parameters
predicate(value: T, index: number, list: NutrientViewer.Immutable.List<T>) => boolean
Called with each value, its index and the list.

contextunknown
Optional
The this value for predicate.

Returns
number
The number of values it returns truthy for.

countBy

countBy<G>(
    grouper: (
        value: T,
        index: number,
        list: NutrientViewer.Immutable.List<T>,
    ) => G,
    context?: unknown,
): NutrientViewer.Immutable.Map<G, number>
Counts the values per key.

Type Parameters
G
Parameters
grouper(value: T, index: number, list: NutrientViewer.Immutable.List<T>) => G
Returns the key each value is counted under.

contextunknown
Optional
The this value for grouper.

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

delete

delete(index: number): NutrientViewer.Immutable.List<T>
Returns a list without the value at index.

Parameters
indexnumber
The position to remove. A negative index counts from the end.

Returns
NutrientViewer.Immutable.List<T>
A new list, or this one when index is out of range.

deleteIn

deleteIn(keyPath: Iterable<unknown>): NutrientViewer.Immutable.List<T>
Returns a list with the value at the end of keyPath removed.

Parameters
keyPathIterable<unknown>
The keys to follow, outermost first.

Returns
NutrientViewer.Immutable.List<T>
A new list, or this one when nothing was removed.

entries

entries(): IterableIterator<[number, T]>
Iterates the [index, value] pairs in order.

Returns
IterableIterator<[number, T]>
An iterator of each pair.

equals

equals(other: unknown): boolean
Reports whether other is an ordered, indexed collection, such as a list, holding equal values in the same order, comparing as is() does.

Parameters
otherunknown
The value to compare against.

Returns
boolean
true when other is an ordered, indexed collection with equal values.

every

every<F>(
    predicate: (
        value: T,
        index: number,
        list: NutrientViewer.Immutable.List<T>,
    ) => value is F,
    context?: unknown,
): this is NutrientViewer.Immutable.List<F>
Reports whether the predicate accepts every value, narrowing the collection to the type predicate guards.

Type Parameters
F
Parameters
predicate(value: T, index: number, list: NutrientViewer.Immutable.List<T>) => value is F
Called with each value and its index until it returns falsy.

contextunknown
Optional
The this value for predicate.

Returns
this is NutrientViewer.Immutable.List<F>
true when every value is accepted, or the list is empty.
every(
    predicate: (
        value: T,
        index: number,
        list: NutrientViewer.Immutable.List<T>,
    ) => boolean,
    context?: unknown,
): boolean
Reports whether the predicate accepts every value.

Parameters
predicate(value: T, index: number, list: NutrientViewer.Immutable.List<T>) => boolean
Called with each value and its index until it returns falsy.

contextunknown
Optional
The this value for predicate.

Returns
boolean
true when every value is accepted, or the list is empty.

filter

filter<F>(
    predicate: (
        value: T,
        index: number,
        list: NutrientViewer.Immutable.List<T>,
    ) => value is F,
    context?: unknown,
): NutrientViewer.Immutable.List<F>
Returns the values the predicate accepts.

Type Parameters
F
Parameters
predicate(value: T, index: number, list: NutrientViewer.Immutable.List<T>) => value is F
Called with each value and its index.

contextunknown
Optional
The this value for predicate.

Returns
NutrientViewer.Immutable.List<F>
A new list.
filter(
    predicate: (
        value: T,
        index: number,
        list: NutrientViewer.Immutable.List<T>,
    ) => unknown,
    context?: unknown,
): NutrientViewer.Immutable.List<T>
Parameters
predicate(value: T, index: number, list: NutrientViewer.Immutable.List<T>) => unknown
contextunknown
Optional
Returns
NutrientViewer.Immutable.List<T>

filterNot

filterNot(
    predicate: (
        value: T,
        index: number,
        list: NutrientViewer.Immutable.List<T>,
    ) => boolean,
    context?: unknown,
): NutrientViewer.Immutable.List<T>
Returns the values the predicate rejects.

Parameters
predicate(value: T, index: number, list: NutrientViewer.Immutable.List<T>) => boolean
Called with each value and its index.

contextunknown
Optional
The this value for predicate.

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

find

find<F>(
    predicate: (
        value: T,
        index: number,
        list: NutrientViewer.Immutable.List<T>,
    ) => 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: T, index: number, list: NutrientViewer.Immutable.List<T>) => value is F
Called with each value, its index and the list until it returns truthy.

contextunknown
Optional
The this value for predicate.

Returns
F | undefined
The first matching value, or undefined.
find<N>(
    predicate: (
        value: T,
        index: number,
        list: NutrientViewer.Immutable.List<T>,
    ) => boolean,
    context: unknown,
    notSetValue: N,
): T | N
Returns the first value the predicate accepts.

Type Parameters
N
Parameters
predicate(value: T, index: number, list: NutrientViewer.Immutable.List<T>) => boolean
Called with each value, its index and the list until it returns truthy.

contextunknown
The this value for predicate.

notSetValueN
Returned when no value matches.

Returns
T | N
The first matching value, or notSetValue.
find(
    predicate: (
        value: T,
        index: number,
        list: NutrientViewer.Immutable.List<T>,
    ) => boolean,
    context?: unknown,
    notSetValue?: T,
): T | undefined
Returns the first value the predicate accepts.

Parameters
predicate(value: T, index: number, list: NutrientViewer.Immutable.List<T>) => boolean
Called with each value, its index and the list until it returns truthy.

contextunknown
Optional
The this value for predicate.

notSetValueT
Optional
Returned when no value matches.

Returns
T | undefined
The first matching value, or notSetValue.

findIndex

findIndex(
    predicate: (
        value: T,
        index: number,
        list: NutrientViewer.Immutable.List<T>,
    ) => boolean,
    context?: unknown,
): number
Returns the index of the first value the predicate accepts.

Parameters
predicate(value: T, index: number, list: NutrientViewer.Immutable.List<T>) => boolean
Called with each value, its index and the list until it returns truthy.

contextunknown
Optional
The this value for predicate.

Returns
number
The index, or -1 when no value matches.

findLast

findLast<F>(
    predicate: (
        value: T,
        index: number,
        list: NutrientViewer.Immutable.List<T>,
    ) => value is F,
    context?: unknown,
): F | undefined
Returns the last value the predicate accepts, searching from the end, narrowed to the type predicate guards.

Type Parameters
F
Parameters
predicate(value: T, index: number, list: NutrientViewer.Immutable.List<T>) => value is F
Called with each value, its index and the list until it returns truthy.

contextunknown
Optional
The this value for predicate.

Returns
F | undefined
The last matching value, or undefined.
findLast<N>(
    predicate: (
        value: T,
        index: number,
        list: NutrientViewer.Immutable.List<T>,
    ) => boolean,
    context: unknown,
    notSetValue: N,
): T | N
Returns the last value the predicate accepts, searching from the end.

Type Parameters
N
Parameters
predicate(value: T, index: number, list: NutrientViewer.Immutable.List<T>) => boolean
Called with each value, its index and the list until it returns truthy.

contextunknown
The this value for predicate.

notSetValueN
Returned when no value matches.

Returns
T | N
The last matching value, or notSetValue.
findLast(
    predicate: (
        value: T,
        index: number,
        list: NutrientViewer.Immutable.List<T>,
    ) => boolean,
    context?: unknown,
    notSetValue?: T,
): T | undefined
Returns the last value the predicate accepts, searching from the end.

Parameters
predicate(value: T, index: number, list: NutrientViewer.Immutable.List<T>) => boolean
Called with each value, its index and the list until it returns truthy.

contextunknown
Optional
The this value for predicate.

notSetValueT
Optional
Returned when no value matches.

Returns
T | undefined
The last matching value, or notSetValue.

findLastEntry

findLastEntry(
    predicate: (
        value: T,
        index: number,
        list: NutrientViewer.Immutable.List<T>,
    ) => boolean,
    context?: unknown,
    notSetValue?: [number, T],
): [number, T] | undefined
Returns the index and value of the last value the predicate accepts.

Parameters
predicate(value: T, index: number, list: NutrientViewer.Immutable.List<T>) => boolean
Called with each value, its index and the list until it returns truthy.

contextunknown
Optional
The this value for predicate.

notSetValue[number, T]
Optional
Returned when no value matches.

Returns
[number, T] | undefined
An [index, value] pair, or notSetValue.

findLastIndex

findLastIndex(
    predicate: (
        value: T,
        index: number,
        list: NutrientViewer.Immutable.List<T>,
    ) => boolean,
    context?: unknown,
): number
Returns the index of the last value the predicate accepts, searching from the end.

Parameters
predicate(value: T, index: number, list: NutrientViewer.Immutable.List<T>) => boolean
Called with each value, its index and the list until it returns truthy.

contextunknown
Optional
The this value for predicate.

Returns
number
The index, or -1 when no value matches.

findLastKey

findLastKey(
    predicate: (
        value: T,
        index: number,
        list: NutrientViewer.Immutable.List<T>,
    ) => boolean,
    context?: unknown,
): number | undefined
Returns the index of the last value the predicate accepts.

Parameters
predicate(value: T, index: number, list: NutrientViewer.Immutable.List<T>) => boolean
Called with each value, its index and the list until it returns truthy.

contextunknown
Optional
The this value for predicate.

Returns
number | undefined
The index, or undefined when no value matches.

first

first(): T | undefined
Returns the first value.

Returns
T | undefined
The first value, or undefined for an empty list.
first<N>(notSetValue: N): T | N
Returns the first value.

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

Returns
T | N
The first value, or notSetValue for an empty list.

flatMap

flatMap<M>(
    mapper: (
        value: T,
        index: number,
        list: NutrientViewer.Immutable.List<T>,
    ) => Iterable<M>,
    context?: unknown,
): NutrientViewer.Immutable.List<M>
Returns a list of the values of the collections mapper returns, one level flattened.

Type Parameters
M
Parameters
mapper(value: T, index: number, list: NutrientViewer.Immutable.List<T>) => Iterable<M>
Called with each value and its index.

contextunknown
Optional
The this value for mapper.

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

flatten

flatten(depth?: number): NutrientViewer.Immutable.List<unknown>
Flattens nested collections. Plain arrays are not flattened.

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

Returns
NutrientViewer.Immutable.List<unknown>
A new list.
flatten(shallow?: boolean): NutrientViewer.Immutable.List<unknown>
Flattens nested collections. Plain arrays are not flattened.

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

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

forEach

forEach(
    sideEffect: (
        value: T,
        index: number,
        list: NutrientViewer.Immutable.List<T>,
    ) => unknown,
    context?: unknown,
): number
Calls sideEffect for each value in order.

Parameters
sideEffect(value: T, index: number, list: NutrientViewer.Immutable.List<T>) => unknown
Called with each value and its index; returning false stops the loop.

contextunknown
Optional
The this value for sideEffect.

Returns
number
The number of values visited, including the one that stopped the loop.

get

get(index: number): T | undefined
Returns the value at index. A negative index counts from the end.

Parameters
indexnumber
The position to read.

Returns
T | undefined
The value, or undefined when index is out of range.
get<N>(index: number, notSetValue: N): T | N
Returns the value at index. A negative index counts from the end.

Type Parameters
N
Parameters
indexnumber
The position to read.

notSetValueN
Returned when index is out of range.

Returns
T | N
The value, or notSetValue when index is out of range.

getIn

getIn(searchKeyPath: Iterable<unknown>, notSetValue?: unknown): unknown
Reads the value at the end of searchKeyPath, walking lists, maps, records and plain objects and arrays.

Parameters
searchKeyPathIterable<unknown>
The keys to follow, outermost first.

notSetValueunknown
Optional
Returned when the path breaks.

Returns
unknown
The value at the path, or notSetValue.

groupBy

groupBy<G>(
    grouper: (
        value: T,
        index: number,
        list: NutrientViewer.Immutable.List<T>,
    ) => G,
    context?: unknown,
): NutrientViewer.Immutable.Map<G, NutrientViewer.Immutable.List<T>>
Groups the values by key, keeping list order within each group.

Type Parameters
G
Parameters
grouper(value: T, index: number, list: NutrientViewer.Immutable.List<T>) => G
Returns the key each value is grouped under.

contextunknown
Optional
The this value for grouper.

Returns
NutrientViewer.Immutable.Map<G, NutrientViewer.Immutable.List<T>>
A map, keyed in order of first appearance, from each key to the list of values that produced it.

has

has(index: number): boolean
Reports whether index is within the list. A negative index counts from the end.

Parameters
indexnumber
The position to look for.

Returns
boolean
true when the list has a value at index, even if that value is undefined.

hashCode

hashCode(): number
Computes a hash of this list from its contents, the same way Immutable.js does. Equal lists have equal hashes; lists 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 searchKeyPath resolves to a value.

Parameters
searchKeyPathIterable<unknown>
The keys to follow, outermost first.

Returns
boolean
true when every key on the path exists.

includes

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

Parameters
valueT
The value to look for.

Returns
boolean
true when an equal value is present.

indexOf

indexOf(searchValue: T): number
Returns the index of the first value equal to searchValue.

Parameters
searchValueT
The value to look for.

Returns
number
The index, or -1 when no value is equal.

insert

insert(index: number, value: T): NutrientViewer.Immutable.List<T>
Returns a list with value inserted at index.

Parameters
indexnumber
The position to insert at. A negative index counts from the end.

valueT
The value to insert.

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

interleave

interleave<C>(
...collections: Iterable<C, any, any>[],
): NutrientViewer.Immutable.List<T | C>
Returns the values of this list and the collections taken in turn, until the shortest runs out.

Type Parameters
C
Parameters
...collectionsIterable<C, any, any>[]
The collections to interleave with.

Returns
NutrientViewer.Immutable.List<T | C>
A new list.

interpose

interpose(separator: T): NutrientViewer.Immutable.List<T>
Returns the list with separator between each pair of values.

Parameters
separatorT
The value to place between values.

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

isEmpty

isEmpty(): boolean
Reports whether the list has no values.

Returns
boolean
true for an empty list.

isSubset

isSubset(iter: Iterable<T>): boolean
Reports whether every value is included in iter.

Parameters
iterIterable<T>
The collection to check against.

Returns
boolean
true when each value of this list is in iter.

isSuperset

isSuperset(iter: Iterable<T>): boolean
Reports whether every value of iter is included in this list.

Parameters
iterIterable<T>
The collection to check.

Returns
boolean
true when each value of iter is in this list.

join

join(separator?: string): string
Joins the values into a string, printing null and undefined as nothing.

Parameters
separatorstring
Optional
Placed between values; defaults to ,.

Returns
string
The joined string.

keyOf

keyOf(searchValue: T): number | undefined
Returns the index of the first value equal to searchValue.

Parameters
searchValueT
The value to look for.

Returns
number | undefined
The index, or undefined when no value is equal.

keys

keys(): IterableIterator<number>
Iterates the indices.

Returns
IterableIterator<number>
An iterator of each index.

last

last(): T | undefined
Returns the last value.

Returns
T | undefined
The last value, or undefined for an empty list.
last<N>(notSetValue: N): T | N
Returns the last value.

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

Returns
T | N
The last value, or notSetValue for an empty list.

lastIndexOf

lastIndexOf(searchValue: T): number
Returns the index of the last value equal to searchValue.

Parameters
searchValueT
The value to look for.

Returns
number
The index, or -1 when no value is equal.

lastKeyOf

lastKeyOf(searchValue: T): number | undefined
Returns the index of the last value equal to searchValue.

Parameters
searchValueT
The value to look for.

Returns
number | undefined
The index, or undefined when no value is equal.

map

map<M>(
    mapper: (
        value: T,
        index: number,
        list: NutrientViewer.Immutable.List<T>,
    ) => M,
    context?: unknown,
): NutrientViewer.Immutable.List<M>
Returns a list of the results of mapper.

Type Parameters
M
Parameters
mapper(value: T, index: number, list: NutrientViewer.Immutable.List<T>) => M
Called with each value and its index.

contextunknown
Optional
The this value for mapper.

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

max

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

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

Returns
T | undefined
The largest value, or undefined for an empty list.

maxBy

maxBy<C>(
    comparatorValueMapper: (
        value: T,
        index: number,
        list: NutrientViewer.Immutable.List<T>,
    ) => C,
    comparator?: (a: C, b: C) => number,
): T | undefined
Returns the value with the largest mapped key.

Type Parameters
C
Parameters
comparatorValueMapper(value: T, index: number, list: NutrientViewer.Immutable.List<T>) => C
Maps each value to the key to compare.

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

Returns
T | undefined
The value, or undefined for an empty list.

merge

merge<C>(
...collections: Iterable<C, any, any>[],
): NutrientViewer.Immutable.List<T | C>
An alias of concat.

Type Parameters
C
Parameters
...collectionsIterable<C, any, any>[]
The collections whose values to add.

Returns
NutrientViewer.Immutable.List<T | C>
A new list, or this one when nothing is added.

mergeDeepIn

mergeDeepIn(
keyPath: Iterable<unknown>,
...collections: unknown[],
): NutrientViewer.Immutable.List<T>
A combination of updateIn and mergeDeep, returning a new List, but performing the deep merge at a point arrived at by following the keyPath. In other words, these two lines are equivalent:
list.updateIn(['a', 'b', 'c'], abc => abc.mergeDeep(y)) list.mergeDeepIn(['a', 'b', 'c'], y)
Note: mergeDeepIn can be used in withMutations.
Parameters
keyPathIterable<unknown>
The keys to follow, outermost first.

...collectionsunknown[]
Collections or plain objects to merge into the value there.

Returns
NutrientViewer.Immutable.List<T>
A new list, or this one when the value is unchanged.

mergeIn

mergeIn(
keyPath: Iterable<unknown>,
...collections: unknown[],
): NutrientViewer.Immutable.List<T>
A combination of updateIn and merge, returning a new List, but performing the merge at a point arrived at by following the keyPath. In other words, these two lines are equivalent:
list.updateIn(['a', 'b', 'c'], abc => abc.merge(y)) list.mergeIn(['a', 'b', 'c'], y)
Note: mergeIn can be used in withMutations.
Parameters
keyPathIterable<unknown>
The keys to follow, outermost first.

...collectionsunknown[]
Collections or plain objects to merge into the value there.

Returns
NutrientViewer.Immutable.List<T>
A new list, or this one when the value is unchanged.

min

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

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

Returns
T | undefined
The smallest value, or undefined for an empty list.

minBy

minBy<C>(
    comparatorValueMapper: (
        value: T,
        index: number,
        list: NutrientViewer.Immutable.List<T>,
    ) => C,
    comparator?: (a: C, b: C) => number,
): T | undefined
Returns the value with the smallest mapped key.

Type Parameters
C
Parameters
comparatorValueMapper(value: T, index: number, list: NutrientViewer.Immutable.List<T>) => C
Maps each value to the key to compare.

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

Returns
T | undefined
The value, or undefined for an empty list.

partition

partition<F, C>(
    predicate: (
        this: C,
        value: T,
        index: number,
        list: NutrientViewer.Immutable.List<T>,
    ) => value is F,
    context?: C,
): [NutrientViewer.Immutable.List<T>, NutrientViewer.Immutable.List<F>]
Splits the values into those the predicate rejects and those it accepts.

Type Parameters
F
C
Parameters
predicate(
this: C,
value: T,
index: number,
list: NutrientViewer.Immutable.List<T>
) => value is F
Called with each value and its index.

contextC
Optional
The this value for predicate.

Returns
[NutrientViewer.Immutable.List<T>, NutrientViewer.Immutable.List<F>]
A pair of lists: the rejected values, then the accepted values.
partition<C>(
    predicate: (
        this: C,
        value: T,
        index: number,
        list: NutrientViewer.Immutable.List<T>,
    ) => unknown,
    context?: C,
): [NutrientViewer.Immutable.List<T>, NutrientViewer.Immutable.List<T>]
Type Parameters
C
Parameters
predicate(
this: C,
value: T,
index: number,
list: NutrientViewer.Immutable.List<T>
) => unknown
contextC
Optional
Returns
[NutrientViewer.Immutable.List<T>, NutrientViewer.Immutable.List<T>]

pop

pop(): NutrientViewer.Immutable.List<T>
Returns a list without the last value.

Returns
NutrientViewer.Immutable.List<T>
A new list, or this one when it is empty.

push

push(...values: T[]): NutrientViewer.Immutable.List<T>
Returns a list with values added to the end.

Parameters
...valuesT[]
The values to add, in order.

Returns
NutrientViewer.Immutable.List<T>
A new list, or this one when no values are given.

reduce

reduce(
    reducer: (
        reduction: T,
        value: T,
        index: number,
        list: NutrientViewer.Immutable.List<T>,
    ) => T,
): T
Folds the values into one, from the first to the last, starting from the first value.

Parameters
reducer(
reduction: T,
value: T,
index: number,
list: NutrientViewer.Immutable.List<T>
) => T
Called with the reduction so far, a value and its index.

Returns
T
The final reduction.
reduce<R>(
    reducer: (
        reduction: R,
        value: T,
        index: number,
        list: NutrientViewer.Immutable.List<T>,
    ) => R,
    initialReduction: R,
    context?: unknown,
): R
Folds the values into one, from the first to the last.

Type Parameters
R
Parameters
reducer(
reduction: R,
value: T,
index: number,
list: NutrientViewer.Immutable.List<T>
) => R
Called with the reduction so far, a value and its index.

initialReductionR
The starting reduction.

contextunknown
Optional
The this value for reducer.

Returns
R
The final reduction.
reduce<R>(
    reducer: (
        reduction: T | R,
        value: T,
        index: number,
        list: NutrientViewer.Immutable.List<T>,
    ) => R,
): R
Folds the values into one, from the first to the last, starting from the first value.

Type Parameters
R
Parameters
reducer(
reduction: T | R,
value: T,
index: number,
list: NutrientViewer.Immutable.List<T>
) => R
Called with the reduction so far, a value and its index.

Returns
R
The final reduction.

reduceRight

reduceRight(
    reducer: (
        reduction: T,
        value: T,
        index: number,
        list: NutrientViewer.Immutable.List<T>,
    ) => T,
): T
Folds the values into one, from the last to the first, starting from the last value.

Parameters
reducer(
reduction: T,
value: T,
index: number,
list: NutrientViewer.Immutable.List<T>
) => T
Called with the reduction so far, a value and its index.

Returns
T
The final reduction.
reduceRight<R>(
    reducer: (
        reduction: R,
        value: T,
        index: number,
        list: NutrientViewer.Immutable.List<T>,
    ) => R,
    initialReduction: R,
    context?: unknown,
): R
Folds the values into one, from the last to the first.

Type Parameters
R
Parameters
reducer(
reduction: R,
value: T,
index: number,
list: NutrientViewer.Immutable.List<T>
) => R
Called with the reduction so far, a value and its index.

initialReductionR
The starting reduction.

contextunknown
Optional
The this value for reducer.

Returns
R
The final reduction.
reduceRight<R>(
    reducer: (
        reduction: T | R,
        value: T,
        index: number,
        list: NutrientViewer.Immutable.List<T>,
    ) => R,
): R
Folds the values into one, from the last to the first, starting from the last value.

Type Parameters
R
Parameters
reducer(
reduction: T | R,
value: T,
index: number,
list: NutrientViewer.Immutable.List<T>
) => R
Called with the reduction so far, a value and its index.

Returns
R
The final reduction.

remove

remove(index: number): NutrientViewer.Immutable.List<T>
An alias of delete.

Parameters
indexnumber
The position to remove. A negative index counts from the end.

Returns
NutrientViewer.Immutable.List<T>
A new list, or this one when index is out of range.

removeIn

removeIn(keyPath: Iterable<unknown>): NutrientViewer.Immutable.List<T>
An alias of deleteIn.

Parameters
keyPathIterable<unknown>
The keys to follow, outermost first.

Returns
NutrientViewer.Immutable.List<T>
A new list, or this one when nothing was removed.

rest

rest(): NutrientViewer.Immutable.List<T>
Returns the list without its first value.

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

reverse

reverse(): NutrientViewer.Immutable.List<T>
Returns the values in reverse order.

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

set

set(index: number, value: T): NutrientViewer.Immutable.List<T>
Returns a list with the value at index replaced. An index past the end pads with undefined; a negative index before the start prepends undefined values.

Parameters
indexnumber
The position to write. A negative index counts from the end.

valueT
The value to store.

Returns
NutrientViewer.Immutable.List<T>
A new list, or this one when the value is unchanged or index is not valid.

setIn

setIn(
keyPath: Iterable<unknown>,
value: unknown,
): NutrientViewer.Immutable.List<T>
Returns a list with the value at the end of keyPath replaced.

Parameters
keyPathIterable<unknown>
The keys to follow, outermost first.

valueunknown
The value to store.

Returns
NutrientViewer.Immutable.List<T>
A new list, or this one when the value is unchanged.

shift

shift(): NutrientViewer.Immutable.List<T>
Returns a list without the first value.

Returns
NutrientViewer.Immutable.List<T>
A new list, or this one when it is empty.

shuffle

shuffle(random?: () => number): NutrientViewer.Immutable.List<T>
Returns the values in a random order.

Parameters
random() => number
Optional
Returns a number in [0, 1); defaults to Math.random.

Returns
NutrientViewer.Immutable.List<T>
A new list, or this one when no value moved.

skip

skip(amount: number): NutrientViewer.Immutable.List<T>
Returns the list without its first amount values.

Parameters
amountnumber
How many values to drop.

Returns
NutrientViewer.Immutable.List<T>
A new list, or this one when amount is not positive.

skipLast

skipLast(amount: number): NutrientViewer.Immutable.List<T>
Returns the list without its last amount values.

Parameters
amountnumber
How many values to drop.

Returns
NutrientViewer.Immutable.List<T>
A new list, or this one when amount is not positive.

skipUntil

skipUntil(
    predicate: (
        value: T,
        index: number,
        list: NutrientViewer.Immutable.List<T>,
    ) => boolean,
    context?: unknown,
): NutrientViewer.Immutable.List<T>
Returns the list without the leading values the predicate rejects.

Parameters
predicate(value: T, index: number, list: NutrientViewer.Immutable.List<T>) => boolean
Called with each value and its index until it returns truthy.

contextunknown
Optional
The this value for predicate.

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

skipWhile

skipWhile(
    predicate: (
        value: T,
        index: number,
        list: NutrientViewer.Immutable.List<T>,
    ) => boolean,
    context?: unknown,
): NutrientViewer.Immutable.List<T>
Returns the list without the leading values the predicate accepts.

Parameters
predicate(value: T, index: number, list: NutrientViewer.Immutable.List<T>) => boolean
Called with each value and its index until it returns falsy.

contextunknown
Optional
The this value for predicate.

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

slice

slice(begin?: number, end?: number): NutrientViewer.Immutable.List<T>
Returns the values from begin up to, but not including, end.

Parameters
beginnumber
Optional
Where to start; negative counts from the end. Defaults to the start.

endnumber
Optional
Where to stop; negative counts from the end. Defaults to the end.

Returns
NutrientViewer.Immutable.List<T>
A new list, or this one when the range covers it all.

some

some(
    predicate: (
        value: T,
        index: number,
        list: NutrientViewer.Immutable.List<T>,
    ) => boolean,
    context?: unknown,
): boolean
Reports whether the predicate accepts any value.

Parameters
predicate(value: T, index: number, list: NutrientViewer.Immutable.List<T>) => boolean
Called with each value and its index until it returns truthy.

contextunknown
Optional
The this value for predicate.

Returns
boolean
true when some value is accepted.

sort

sort(comparator?: (a: T, b: T) => number): NutrientViewer.Immutable.List<T>
Returns the values sorted. The sort is stable.

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

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

sortBy

sortBy<C>(
    comparatorValueMapper: (
        value: T,
        index: number,
        list: NutrientViewer.Immutable.List<T>,
    ) => C,
    comparator?: (a: C, b: C) => number,
): NutrientViewer.Immutable.List<T>
Returns the values sorted by a mapped key. The sort is stable.

Type Parameters
C
Parameters
comparatorValueMapper(value: T, index: number, list: NutrientViewer.Immutable.List<T>) => C
Maps each value to the key to sort by.

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

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

splice

splice(
    index: number,
    removeNum: number,
    ...values: T[],
): NutrientViewer.Immutable.List<T>
Returns a list with removeNum values removed at index and values inserted there.

Parameters
indexnumber
Where to start. A negative index counts from the end.

removeNumnumber
How many values to remove.

...valuesT[]
The values to insert.

Returns
NutrientViewer.Immutable.List<T>
A new list, or this one when nothing is removed or inserted.

take

take(amount: number): NutrientViewer.Immutable.List<T>
Returns the first amount values.

Parameters
amountnumber
How many values to keep.

Returns
NutrientViewer.Immutable.List<T>
A new list, or this one when amount covers it all.

takeLast

takeLast(amount: number): NutrientViewer.Immutable.List<T>
Returns the last amount values.

Parameters
amountnumber
How many values to keep.

Returns
NutrientViewer.Immutable.List<T>
A new list, or this one when amount covers it all.

takeUntil

takeUntil(
    predicate: (
        value: T,
        index: number,
        list: NutrientViewer.Immutable.List<T>,
    ) => boolean,
    context?: unknown,
): NutrientViewer.Immutable.List<T>
Returns the leading values the predicate rejects.

Parameters
predicate(value: T, index: number, list: NutrientViewer.Immutable.List<T>) => boolean
Called with each value and its index until it returns truthy.

contextunknown
Optional
The this value for predicate.

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

takeWhile

takeWhile(
    predicate: (
        value: T,
        index: number,
        list: NutrientViewer.Immutable.List<T>,
    ) => boolean,
    context?: unknown,
): NutrientViewer.Immutable.List<T>
Returns the leading values the predicate accepts.

Parameters
predicate(value: T, index: number, list: NutrientViewer.Immutable.List<T>) => boolean
Called with each value and its index until it returns falsy.

contextunknown
Optional
The this value for predicate.

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

toArray

toArray(): T[]
Converts the list to an array of its values, leaving nested collections as they are.

Returns
T[]
A new array.

toJS

toJS(): CollectionPlainValue<T>[]
Converts the list to plain values all the way down: nested collections, records, arrays and plain objects become plain arrays and objects.

Returns
CollectionPlainValue<T>[]
A new array of plain values.

toJSON

toJSON(): T[]
Converts the list to an array of its values, leaving nested collections as they are, for JSON.stringify.

Returns
T[]
A new array.

toList

toList(): NutrientViewer.Immutable.List<T>
Returns this list.

Returns
NutrientViewer.Immutable.List<T>
This list.

toMap

toMap(): NutrientViewer.Immutable.Map<number, T>
Converts the list to a map from each index to its value.

Returns
NutrientViewer.Immutable.Map<number, T>
A new map.

toObject

toObject(): { [key: string]: T }
Converts the list to an object keyed by index.

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

toOrderedMap

toOrderedMap(): OrderedMap<number, T>
Converts the list to an ordered map from each index to its value.

Returns
OrderedMap<number, T>
A new ordered map.

toOrderedSet

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

Returns
OrderedSet<T>
A new ordered set.

toSet

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

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

toString

toString(): string
Prints the list, for example List [ 1, "a" ].

Returns
string
The printed list.

unshift

unshift(...values: T[]): NutrientViewer.Immutable.List<T>
Returns a list with values added to the start.

Parameters
...valuesT[]
The values to add; they end up in argument order.

Returns
NutrientViewer.Immutable.List<T>
A new list, or this one when no values are given.

update

update(
    index: number,
    notSetValue: T,
    updater: (value: T) => T,
): NutrientViewer.Immutable.List<T>
Returns a list with the value at index replaced by the result of updater.

Parameters
indexnumber
The position to update.

notSetValueT
The value passed to the updater when index is missing.

updater(value: T) => T
Returns the new value.

Returns
NutrientViewer.Immutable.List<T>
A new list, or this one when the value is unchanged.
update(
index: number,
updater: (value: T | undefined) => T | undefined,
): NutrientViewer.Immutable.List<T>
Returns a list with the value at index replaced by the result of updater.

Parameters
indexnumber
The position to update.

updater(value: T | undefined) => T | undefined
Returns the new value.

Returns
NutrientViewer.Immutable.List<T>
A new list, or this one when the value is unchanged.
update<R>(updater: (value: NutrientViewer.Immutable.List<T>) => R): R
Returns the result of calling updater with this list.

Type Parameters
R
Parameters
updater(value: NutrientViewer.Immutable.List<T>) => R
Receives the list.

Returns
R
The updater's result.

updateIn

updateIn(
    keyPath: Iterable<unknown>,
    notSetValue: unknown,
    updater: (value: unknown) => unknown,
): NutrientViewer.Immutable.List<T>
Returns a list with the value at the end of keyPath replaced by the result of updater.

Parameters
keyPathIterable<unknown>
The keys to follow, outermost first.

notSetValueunknown
The value passed to the updater when the path is missing.

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

Returns
NutrientViewer.Immutable.List<T>
A new list, or this one when the value is unchanged.
updateIn(
keyPath: Iterable<unknown>,
updater: (value: unknown) => unknown,
): NutrientViewer.Immutable.List<T>
Returns a list with the value at the end of keyPath replaced by the result of updater.

Parameters
keyPathIterable<unknown>
The keys to follow, outermost first.

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

Returns
NutrientViewer.Immutable.List<T>
A new list, or this one when the value is unchanged.

values

values(): IterableIterator<T>
Iterates the values in order.

Returns
IterableIterator<T>
An iterator of each value.

withMutations

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

Parameters
mutator(mutable: NutrientViewer.Immutable.List<T>) => unknown
Called once with the draft.

Returns
NutrientViewer.Immutable.List<T>
A new list holding the changes, or this one when the mutator changed nothing.

Interface List

Type Parameters

Properties

Methods

Returns

Returns

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Type Parameters

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

Parameters

Returns

Type Parameters

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Type Parameters

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters