Interface Set

An immutable, unordered collection of unique values. Every change returns a new set and leaves the original untouched; a change that would not alter the set returns the same set. Values are compared as is() does, so collections and records with equal values are the same member.

Interface

Type Parameters

Properties

size

Readonly

number

The number of values in the set.

Methods

[iterator]

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

Returns
IterableIterator<T>
An iterator of the values.

add

add(value: T): NutrientViewer.Immutable.Set<T>
Adds value.

Parameters
valueT
The value to add.

Returns
NutrientViewer.Immutable.Set<T>
A new set, or this one when it already has value.

butLast

butLast(): NutrientViewer.Immutable.Set<T>
Returns every value but the last.

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

clear

clear(): NutrientViewer.Immutable.Set<T>
Removes every value.

Returns
NutrientViewer.Immutable.Set<T>
An empty set.

concat

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

Type Parameters
C
Parameters
...collectionsIterable<C, any, any>[]
Iterables of values. A string is added as one value.

Returns
NutrientViewer.Immutable.Set<T | C>
A new set, 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 the set has value.

count

count(): number
Counts the values.

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

Parameters
predicate(value: T, key: T, set: NutrientViewer.Immutable.Set<T>) => boolean
Called with each value, again as its key, and the set.

contextunknown
Optional
The this value for predicate.

Returns
number
The number of accepted values.

countBy

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

Type Parameters
G
Parameters
grouper(value: T, key: T, set: NutrientViewer.Immutable.Set<T>) => G
Returns the group each value is counted under.

contextunknown
Optional
The this value for grouper.

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

delete

delete(value: T): NutrientViewer.Immutable.Set<T>
Removes value.

Parameters
valueT
The value to remove.

Returns
NutrientViewer.Immutable.Set<T>
A new set, or this one when it has no such value.

entries

entries(): IterableIterator<[T, T]>
Iterates the values as [value, value] pairs.

Returns
IterableIterator<[T, T]>
An iterator of pairs.

equals

equals(other: unknown): boolean
Compares this set with another collection by value.

Parameters
otherunknown
The value to compare with.

Returns
boolean
true when other is a set of equal values. A set is never equal to an ordered set.

every

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

Type Parameters
F
Parameters
predicate(value: T, key: T, set: NutrientViewer.Immutable.Set<T>) => value is F
Called with each value, again as its key, and the set.

contextunknown
Optional
The this value for predicate.

Returns
this is NutrientViewer.Immutable.Set<F>
true when every value is accepted, including for an empty set.
every(
    predicate: (
        value: T,
        key: T,
        set: NutrientViewer.Immutable.Set<T>,
    ) => boolean,
    context?: unknown,
): boolean
Reports whether the predicate accepts every value.

Parameters
predicate(value: T, key: T, set: NutrientViewer.Immutable.Set<T>) => boolean
Called with each value, again as its key, and the set.

contextunknown
Optional
The this value for predicate.

Returns
boolean
true when every value is accepted, including for an empty set.

filter

filter<F>(
    predicate: (
        value: T,
        key: T,
        set: NutrientViewer.Immutable.Set<T>,
    ) => value is F,
    context?: unknown,
): NutrientViewer.Immutable.Set<F>
Returns the values the predicate accepts.

Type Parameters
F
Parameters
predicate(value: T, key: T, set: NutrientViewer.Immutable.Set<T>) => value is F
Called with each value, again as its key, and the set.

contextunknown
Optional
The this value for predicate.

Returns
NutrientViewer.Immutable.Set<F>
A new set.
filter(
    predicate: (
        value: T,
        key: T,
        set: NutrientViewer.Immutable.Set<T>,
    ) => unknown,
    context?: unknown,
): NutrientViewer.Immutable.Set<T>
Parameters
predicate(value: T, key: T, set: NutrientViewer.Immutable.Set<T>) => unknown
contextunknown
Optional
Returns
NutrientViewer.Immutable.Set<T>

filterNot

filterNot(
    predicate: (
        value: T,
        key: T,
        set: NutrientViewer.Immutable.Set<T>,
    ) => boolean,
    context?: unknown,
): NutrientViewer.Immutable.Set<T>
Returns the values the predicate rejects.

Parameters
predicate(value: T, key: T, set: NutrientViewer.Immutable.Set<T>) => boolean
Called with each value, again as its key, and the set.

contextunknown
Optional
The this value for predicate.

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

find

find<F>(
    predicate: (
        value: T,
        key: T,
        set: NutrientViewer.Immutable.Set<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, key: T, set: NutrientViewer.Immutable.Set<T>) => value is F
Called with each value, again as its key, and the set.

contextunknown
Optional
The this value for predicate.

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

Type Parameters
N
Parameters
predicate(value: T, key: T, set: NutrientViewer.Immutable.Set<T>) => boolean
Called with each value, again as its key, and the set.

contextunknown
The this value for predicate.

notSetValueN
Returned when no value is accepted.

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

Parameters
predicate(value: T, key: T, set: NutrientViewer.Immutable.Set<T>) => boolean
Called with each value, again as its key, and the set.

contextunknown
Optional
The this value for predicate.

notSetValueT
Optional
Returned when no value is accepted.

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

findLast

findLast<F>(
    predicate: (
        value: T,
        key: T,
        set: NutrientViewer.Immutable.Set<T>,
    ) => 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: T, key: T, set: NutrientViewer.Immutable.Set<T>) => value is F
Called with each value, again as its key, and the set.

contextunknown
Optional
The this value for predicate.

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

Type Parameters
N
Parameters
predicate(value: T, key: T, set: NutrientViewer.Immutable.Set<T>) => boolean
Called with each value, again as its key, and the set.

contextunknown
The this value for predicate.

notSetValueN
Returned when no value is accepted.

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

Parameters
predicate(value: T, key: T, set: NutrientViewer.Immutable.Set<T>) => boolean
Called with each value, again as its key, and the set.

contextunknown
Optional
The this value for predicate.

notSetValueT
Optional
Returned when no value is accepted.

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

findLastEntry

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

Parameters
predicate(value: T, key: T, set: NutrientViewer.Immutable.Set<T>) => boolean
Called with each value, again as its key, and the set.

contextunknown
Optional
The this value for predicate.

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

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

findLastKey

findLastKey(
    predicate: (
        value: T,
        key: T,
        set: NutrientViewer.Immutable.Set<T>,
    ) => boolean,
    context?: unknown,
): T | undefined
Returns the last value the predicate accepts.

Parameters
predicate(value: T, key: T, set: NutrientViewer.Immutable.Set<T>) => boolean
Called with each value, again as its key, and the set.

contextunknown
Optional
The this value for predicate.

Returns
T | undefined
The last accepted value, or undefined when none is accepted.

first

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

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

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

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

flatMap

flatMap<M>(
    mapper: (
        value: T,
        key: T,
        set: NutrientViewer.Immutable.Set<T>,
    ) => Iterable<M>,
    context?: unknown,
): NutrientViewer.Immutable.Set<M>
Returns a set of the values of the iterables mapper returns.

Type Parameters
M
Parameters
mapper(value: T, key: T, set: NutrientViewer.Immutable.Set<T>) => Iterable<M>
Called with each value, again as its key, and the set.

contextunknown
Optional
The this value for mapper.

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

flatten

flatten(depth?: number): NutrientViewer.Immutable.Set<unknown>
Returns a set of the values of the collections nested in this set, at every depth or down to depth.

Parameters
depthnumber
Optional
How many levels to flatten; every level when omitted.

Returns
NutrientViewer.Immutable.Set<unknown>
A new set.
flatten(shallow?: boolean): NutrientViewer.Immutable.Set<unknown>
Returns a set of the values of the collections nested in this set, one level deep when shallow is true and at every depth otherwise.

Parameters
shallowboolean
Optional
Whether to flatten one level only.

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

forEach

forEach(
    sideEffect: (
        value: T,
        key: T,
        set: NutrientViewer.Immutable.Set<T>,
    ) => unknown,
    context?: unknown,
): number
Calls sideEffect with each value until it returns false.

Parameters
sideEffect(value: T, key: T, set: NutrientViewer.Immutable.Set<T>) => unknown
Called with each value, again as its key, and the set.

contextunknown
Optional
The this value for sideEffect.

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

get

get(value: T): T | undefined
Returns value when the set has an equal value.

Parameters
valueT
The value to look for.

Returns
T | undefined
value, or undefined when the set has no equal value.
get<N>(value: T, notSetValue: N): T | N
Returns value when the set has an equal value.

Type Parameters
N
Parameters
valueT
The value to look for.

notSetValueN
Returned when the set has no equal value.

Returns
T | N
value, or notSetValue when the set has no equal value.

getIn

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

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

notSetValueunknown
Optional
Returned when the path does not exist.

Returns
unknown
The value at the path, or notSetValue.

groupBy

groupBy<G>(
grouper: (value: T, key: T, set: NutrientViewer.Immutable.Set<T>) => G,
context?: unknown,
): NutrientViewer.Immutable.Map<G, NutrientViewer.Immutable.Set<T>>
Groups the values.

Type Parameters
G
Parameters
grouper(value: T, key: T, set: NutrientViewer.Immutable.Set<T>) => G
Returns the group each value belongs to.

contextunknown
Optional
The this value for grouper.

Returns
NutrientViewer.Immutable.Map<G, NutrientViewer.Immutable.Set<T>>
A map from each group to a set of the values that produced it.

has

has(value: T): boolean
Reports whether the set has value.

Parameters
valueT
The value to look for.

Returns
boolean
true when the set has value.

hashCode

hashCode(): number
Computes a hash of this set from its contents, the same way Immutable.js does. Equal sets have equal hashes; sets 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 set inwards.

Returns
boolean
true when every key on the path exists.

includes

includes(value: T): boolean
Reports whether the set has value.

Parameters
valueT
The value to look for.

Returns
boolean
true when the set has value.

intersect

intersect(
...collections: Iterable<T, any, any>[],
): NutrientViewer.Immutable.Set<T>
Keeps the values every collection includes.

Parameters
...collectionsIterable<T, any, any>[]
The iterables to intersect with.

Returns
NutrientViewer.Immutable.Set<T>
A new set, or this one when every value is kept.

isEmpty

isEmpty(): boolean
Reports whether the set is empty.

Returns
boolean
true when the set has no values.

isSubset

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

Parameters
iterIterable<T>
The values to look in.

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

isSuperset

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

Parameters
iterIterable<T>
The values to check.

Returns
boolean
true when this set has each value of iter.

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 a comma.

Returns
string
The joined string.

keyOf

keyOf(value: T): T | undefined
Returns value when the set has an equal value.

Parameters
valueT
The value to look for.

Returns
T | undefined
value, or undefined when the set has no equal value.

keys

keys(): IterableIterator<T>
Iterates the values.

Returns
IterableIterator<T>
An iterator of the values.

last

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

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

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

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

lastKeyOf

lastKeyOf(value: T): T | undefined
Returns value when the set has an equal value.

Parameters
valueT
The value to look for.

Returns
T | undefined
value, or undefined when the set has no equal value.

map

map<M>(
mapper: (value: T, key: T, set: NutrientViewer.Immutable.Set<T>) => M,
context?: unknown,
): NutrientViewer.Immutable.Set<M>
Returns a set of the results of mapper. Results that are equal collapse into one value.

Type Parameters
M
Parameters
mapper(value: T, key: T, set: NutrientViewer.Immutable.Set<T>) => M
Called with each value, again as its key, and the set.

contextunknown
Optional
The this value for mapper.

Returns
NutrientViewer.Immutable.Set<M>
A new set, 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 set.

maxBy

maxBy<C>(
    comparatorValueMapper: (
        value: T,
        key: T,
        set: NutrientViewer.Immutable.Set<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, key: T, set: NutrientViewer.Immutable.Set<T>) => C
Maps each value to the key to compare by.

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

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

merge

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

Type Parameters
C
Parameters
...collectionsIterable<C, any, any>[]
Iterables of values. A string is added as one value.

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

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 set.

minBy

minBy<C>(
    comparatorValueMapper: (
        value: T,
        key: T,
        set: NutrientViewer.Immutable.Set<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, key: T, set: NutrientViewer.Immutable.Set<T>) => C
Maps each value to the key to compare by.

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

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

partition

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

Type Parameters
F
C
Parameters
predicate(this: C, value: T, key: T, set: NutrientViewer.Immutable.Set<T>) => value is F
Called with each value, again as its key, and the set.

contextC
Optional
The this value for predicate.

Returns
[NutrientViewer.Immutable.Set<T>, NutrientViewer.Immutable.Set<F>]
A pair of sets: the rejected values, then the accepted values.
partition<C>(
    predicate: (
        this: C,
        value: T,
        key: T,
        set: NutrientViewer.Immutable.Set<T>,
    ) => unknown,
    context?: C,
): [NutrientViewer.Immutable.Set<T>, NutrientViewer.Immutable.Set<T>]
Type Parameters
C
Parameters
predicate(this: C, value: T, key: T, set: NutrientViewer.Immutable.Set<T>) => unknown
contextC
Optional
Returns
[NutrientViewer.Immutable.Set<T>, NutrientViewer.Immutable.Set<T>]

reduce

reduce(
    reducer: (
        reduction: T,
        value: T,
        key: T,
        set: NutrientViewer.Immutable.Set<T>,
    ) => T,
): T
Reduces the values to one, starting from the first value.

Parameters
reducer(reduction: T, value: T, key: T, set: NutrientViewer.Immutable.Set<T>) => T
Called with the reduction so far, each remaining value, again as its key, and the set.

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

Type Parameters
R
Parameters
reducer(reduction: R, value: T, key: T, set: NutrientViewer.Immutable.Set<T>) => R
Called with the reduction so far, each value, again as its key, and the set.

initialReductionR
The first reduction.

contextunknown
Optional
The this value for reducer.

Returns
R
The reduction.
reduce<R>(
    reducer: (
        reduction: T | R,
        value: T,
        key: T,
        set: NutrientViewer.Immutable.Set<T>,
    ) => R,
): R
Type Parameters
R
Parameters
reducer(reduction: T | R, value: T, key: T, set: NutrientViewer.Immutable.Set<T>) => R
Returns
R

reduceRight

reduceRight(
    reducer: (
        reduction: T,
        value: T,
        key: T,
        set: NutrientViewer.Immutable.Set<T>,
    ) => T,
): T
Reduces the values to one, from the last value to the first, starting from the last value.

Parameters
reducer(reduction: T, value: T, key: T, set: NutrientViewer.Immutable.Set<T>) => T
Called with the reduction so far, each earlier value, again as its key, and the set.

Returns
T
The reduction, or undefined for an empty set.
reduceRight<R>(
    reducer: (
        reduction: R,
        value: T,
        key: T,
        set: NutrientViewer.Immutable.Set<T>,
    ) => 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: T, key: T, set: NutrientViewer.Immutable.Set<T>) => R
Called with the reduction so far, each value, again as its key, and the set.

initialReductionR
The first reduction.

contextunknown
Optional
The this value for reducer.

Returns
R
The reduction.
reduceRight<R>(
    reducer: (
        reduction: T | R,
        value: T,
        key: T,
        set: NutrientViewer.Immutable.Set<T>,
    ) => R,
): R
Type Parameters
R
Parameters
reducer(reduction: T | R, value: T, key: T, set: NutrientViewer.Immutable.Set<T>) => R
Returns
R

remove

remove(value: T): NutrientViewer.Immutable.Set<T>
An alias of delete.

Parameters
valueT
The value to remove.

Returns
NutrientViewer.Immutable.Set<T>
A new set, or this one when it has no such value.

rest

rest(): NutrientViewer.Immutable.Set<T>
Returns every value but the first.

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

reverse

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

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

skip

skip(amount: number): NutrientViewer.Immutable.Set<T>
Skips values from the start.

Parameters
amountnumber
How many values to skip.

Returns
NutrientViewer.Immutable.Set<T>
A new set, or this one when amount is 0.

skipLast

skipLast(amount: number): NutrientViewer.Immutable.Set<T>
Skips values from the end.

Parameters
amountnumber
How many values to skip.

Returns
NutrientViewer.Immutable.Set<T>
A new set, or this one when amount is 0.

skipUntil

skipUntil(
    predicate: (
        value: T,
        key: T,
        set: NutrientViewer.Immutable.Set<T>,
    ) => boolean,
    context?: unknown,
): NutrientViewer.Immutable.Set<T>
Skips values from the start until the predicate accepts one.

Parameters
predicate(value: T, key: T, set: NutrientViewer.Immutable.Set<T>) => boolean
Called with each value, again as its key, and the set.

contextunknown
Optional
The this value for predicate.

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

skipWhile

skipWhile(
    predicate: (
        value: T,
        key: T,
        set: NutrientViewer.Immutable.Set<T>,
    ) => boolean,
    context?: unknown,
): NutrientViewer.Immutable.Set<T>
Skips values from the start while the predicate accepts them.

Parameters
predicate(value: T, key: T, set: NutrientViewer.Immutable.Set<T>) => boolean
Called with each value, again as its key, and the set.

contextunknown
Optional
The this value for predicate.

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

slice

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

Parameters
beginnumber
Optional
The first position to keep; negative counts from the end.

endnumber
Optional
The position to stop before; negative counts from the end.

Returns
NutrientViewer.Immutable.Set<T>
A new set, or this one when begin is given and the range covers every value.

some

some(
    predicate: (
        value: T,
        key: T,
        set: NutrientViewer.Immutable.Set<T>,
    ) => boolean,
    context?: unknown,
): boolean
Reports whether the predicate accepts any value.

Parameters
predicate(value: T, key: T, set: NutrientViewer.Immutable.Set<T>) => boolean
Called with each value, again as its key, and the set.

contextunknown
Optional
The this value for predicate.

Returns
boolean
true when at least one value is accepted.

sort

sort(comparator?: (a: T, b: T) => number): OrderedSet<T>
Returns the values sorted.

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

Returns
OrderedSet<T>
A new ordered set.

sortBy

sortBy<C>(
mapper: (value: T, key: T, set: NutrientViewer.Immutable.Set<T>) => C,
comparator?: (a: C, b: C) => number,
): OrderedSet<T>
Returns the values ordered by the results of mapper.

Type Parameters
C
Parameters
mapper(value: T, key: T, set: NutrientViewer.Immutable.Set<T>) => C
Called with each value, again as its key, and the set.

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

Returns
OrderedSet<T>
A new ordered set.

subtract

subtract(
...collections: Iterable<T, any, any>[],
): NutrientViewer.Immutable.Set<T>
Removes the values any collection includes.

Parameters
...collectionsIterable<T, any, any>[]
The iterables to subtract.

Returns
NutrientViewer.Immutable.Set<T>
A new set, or this one when nothing is removed.

take

take(amount: number): NutrientViewer.Immutable.Set<T>
Keeps values from the start.

Parameters
amountnumber
How many values to keep.

Returns
NutrientViewer.Immutable.Set<T>
A new set, or this one when it has no more than amount values.

takeLast

takeLast(amount: number): NutrientViewer.Immutable.Set<T>
Keeps values from the end.

Parameters
amountnumber
How many values to keep.

Returns
NutrientViewer.Immutable.Set<T>
A new set, or this one when it has no more than amount values.

takeUntil

takeUntil(
    predicate: (
        value: T,
        key: T,
        set: NutrientViewer.Immutable.Set<T>,
    ) => boolean,
    context?: unknown,
): NutrientViewer.Immutable.Set<T>
Keeps values from the start until the predicate accepts one.

Parameters
predicate(value: T, key: T, set: NutrientViewer.Immutable.Set<T>) => boolean
Called with each value, again as its key, and the set.

contextunknown
Optional
The this value for predicate.

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

takeWhile

takeWhile(
    predicate: (
        value: T,
        key: T,
        set: NutrientViewer.Immutable.Set<T>,
    ) => boolean,
    context?: unknown,
): NutrientViewer.Immutable.Set<T>
Keeps values from the start while the predicate accepts them.

Parameters
predicate(value: T, key: T, set: NutrientViewer.Immutable.Set<T>) => boolean
Called with each value, again as its key, and the set.

contextunknown
Optional
The this value for predicate.

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

toArray

toArray(): T[]
Converts the set to an array of its values.

Returns
T[]
A new array.

toJS

toJS(): CollectionPlainValue<T>[]
Converts the set 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.

toJSON

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

Returns
T[]
A new array.

toList

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

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

toMap

toMap(): NutrientViewer.Immutable.Map<T, T>
Converts the set to a map from each value to itself.

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

toObject

toObject(): { [key: string]: T }
Converts the set to an object keyed by each value, with the value stored under it.

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

toOrderedMap

toOrderedMap(): OrderedMap<T, T>
Converts the set to an ordered map from each value to itself, in iteration order.

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

toOrderedSet

toOrderedSet(): OrderedSet<T>
Converts the set to an ordered set in iteration order.

Returns
OrderedSet<T>
A new ordered set.

toSet

toSet(): NutrientViewer.Immutable.Set<T>
Converts the set to a set.

Returns
NutrientViewer.Immutable.Set<T>
This set, or a new set when this is an ordered set.

toString

toString(): string
Returns a readable description of the set.

Returns
string
A string such as Set { 1, 2 }.

union

union<C>(
...collections: Iterable<C, any, any>[],
): NutrientViewer.Immutable.Set<T | C>
Adds the values of the collections.

Type Parameters
C
Parameters
...collectionsIterable<C, any, any>[]
Iterables of values. A string is added as one value.

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

update

update<R>(updater: (value: NutrientViewer.Immutable.Set<T>) => R): R
Passes the set to updater.

Type Parameters
R
Parameters
updater(value: NutrientViewer.Immutable.Set<T>) => R
Called once with this set.

Returns
R
Whatever updater returns.

values

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

Returns
IterableIterator<T>
An iterator of the values.

withMutations

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

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

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

Interface Set

Type Parameters

Properties

Methods

Returns

Parameters

Returns

Returns

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Type Parameters

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

Parameters

Returns

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Type Parameters

Parameters

Returns