Interface Set

Interface

Type Parameters

Hierarchy

SetSet

Properties

size

Readonly

number

The number of items in this Set.

Methods

add

add(value: T): this
Returns a new Set which also includes this value.

Note: add can be used in withMutations.

Parameters
valueT
Returns
this

asImmutable

asImmutable(): this
Returns
this
See Also
Map#asImmutable

asMutable

asMutable(): this
Note: Not all methods can be used on a mutable collection or within withMutations! Check the documentation for each method to see if it mentions being safe to use in withMutations.
Returns
this
See Also
Map#asMutable

butLast

butLast(): this
Returns a new Collection of the same type containing all entries except the last.

Returns
this
Inherited from Collection.Set.butLast

clear

clear(): this
Returns a new Set containing no values.

Note: clear can be used in withMutations.

Returns
this

concat

concat<C>(
...collections: Iterable<C, any, any>[],
): NutrientViewer.Immutable.Set<T | C>
Returns a new Collection with other collections concatenated to this one.

Type Parameters
C
Parameters
...collectionsIterable<C, any, any>[]
Returns
NutrientViewer.Immutable.Set<T | C>
Overrides Collection.Set.concat

contains

contains(value: T): boolean
Parameters
valueT
Returns
boolean
Inherited from Collection.Set.contains

count

count(): number
Returns the size of this Collection.

Regardless of if this Collection can describe its size lazily (some Seqs cannot), this method will always return the correct size. E.g. it evaluates a lazy Seq if necessary.

If predicate is provided, then this returns the count of entries in the Collection for which the predicate returns true.

Returns
number
Inherited from Collection.Set.count
count(
predicate: (value: T, key: T, iter: this) => boolean,
context?: unknown,
): number
Parameters
predicate(value: T, key: T, iter: this) => boolean
contextunknown
Optional
Returns
number
Inherited from Collection.Set.count

countBy

countBy<G>(
grouper: (value: T, key: T, iter: this) => G,
context?: unknown,
): Map<G, number>
Returns a Seq.Keyed of counts, grouped by the return value of the grouper function.

Note: This is not a lazy operation.

Type Parameters
G
Parameters
grouper(value: T, key: T, iter: this) => G
contextunknown
Optional
Returns
Map<G, number>
Inherited from Collection.Set.countBy

delete

delete(value: T): this
Returns a new Set which excludes this value.

Note: delete can be used in withMutations.

Note: delete cannot be safely used in IE8, use remove if supporting old browsers.

Parameters
valueT
Returns
this

entries

entries(): IterableIterator<[T, T]>
An iterator of this Collection's entries as [ key, value ] tuples.

Note: this will return an ES6 iterator which does not support Immutable.js sequence algorithms. Use entrySeq instead, if this is what you want.

Returns
IterableIterator<[T, T]>
Inherited from Collection.Set.entries

entrySeq

entrySeq(): Indexed<[T, T]>
Returns a new Seq.Indexed of [key, value] tuples.

Returns
Indexed<[T, T]>
Inherited from Collection.Set.entrySeq

every

every(
predicate: (value: T, key: T, iter: this) => boolean,
context?: unknown,
): boolean
True if predicate returns true for all entries in the Collection.

Parameters
predicate(value: T, key: T, iter: this) => boolean
contextunknown
Optional
Returns
boolean
Inherited from Collection.Set.every

filter

filter<F>(
predicate: (value: T, key: T, iter: this) => value is F,
context?: unknown,
): NutrientViewer.Immutable.Set<F>
Returns a new Set with only the values for which the predicate function returns true.

Note: filter() always returns a new instance, even if it results in not filtering out any values.

Type Parameters
F
Parameters
predicate(value: T, key: T, iter: this) => value is F
contextunknown
Optional
Returns
NutrientViewer.Immutable.Set<F>
Overrides Collection.Set.filter
filter(
predicate: (value: T, key: T, iter: this) => unknown,
context?: unknown,
): this
Returns a new Collection with only the values for which the predicate function returns true.

Note: filter() always returns a new instance, even if it results in not filtering out any values.

Parameters
predicate(value: T, key: T, iter: this) => unknown
contextunknown
Optional
Returns
this
Overrides Collection.Set.filter

filterNot

filterNot(
predicate: (value: T, key: T, iter: this) => boolean,
context?: unknown,
): this
Returns a new Collection of the same type with only the entries for which the predicate function returns false.

Note: filterNot() always returns a new instance, even if it results in not filtering out any values.

Parameters
predicate(value: T, key: T, iter: this) => boolean
contextunknown
Optional
Returns
this
Inherited from Collection.Set.filterNot

find

find(
    predicate: (value: T, key: T, iter: this) => boolean,
    context?: unknown,
    notSetValue?: T,
): T | undefined
Returns the first value for which the predicate returns true.

Parameters
predicate(value: T, key: T, iter: this) => boolean
contextunknown
Optional
notSetValueT
Optional
Returns
T | undefined
Inherited from Collection.Set.find

findEntry

findEntry(
    predicate: (value: T, key: T, iter: this) => boolean,
    context?: unknown,
    notSetValue?: T,
): [T, T] | undefined
Returns the first [key, value] entry for which the predicate returns true.

Parameters
predicate(value: T, key: T, iter: this) => boolean
contextunknown
Optional
notSetValueT
Optional
Returns
[T, T] | undefined
Inherited from Collection.Set.findEntry

findKey

findKey(
predicate: (value: T, key: T, iter: this) => boolean,
context?: unknown,
): T | undefined
Returns the key for which the predicate returns true.

Parameters
predicate(value: T, key: T, iter: this) => boolean
contextunknown
Optional
Returns
T | undefined
Inherited from Collection.Set.findKey

findLast

findLast(
    predicate: (value: T, key: T, iter: this) => boolean,
    context?: unknown,
    notSetValue?: T,
): T | undefined
Returns the last value for which the predicate returns true.

Note: predicate will be called for each entry in reverse.

Parameters
predicate(value: T, key: T, iter: this) => boolean
contextunknown
Optional
notSetValueT
Optional
Returns
T | undefined
Inherited from Collection.Set.findLast

findLastEntry

findLastEntry(
    predicate: (value: T, key: T, iter: this) => boolean,
    context?: unknown,
    notSetValue?: T,
): [T, T] | undefined
Returns the last [key, value] entry for which the predicate returns true.

Note: predicate will be called for each entry in reverse.

Parameters
predicate(value: T, key: T, iter: this) => boolean
contextunknown
Optional
notSetValueT
Optional
Returns
[T, T] | undefined
Inherited from Collection.Set.findLastEntry

findLastKey

findLastKey(
predicate: (value: T, key: T, iter: this) => boolean,
context?: unknown,
): T | undefined
Returns the last key for which the predicate returns true.

Note: predicate will be called for each entry in reverse.

Parameters
predicate(value: T, key: T, iter: this) => boolean
contextunknown
Optional
Returns
T | undefined
Inherited from Collection.Set.findLastKey

first

first<NSV>(notSetValue: NSV): T | NSV
In case the Collection is not empty returns the first element of the Collection. In case the Collection is empty returns the optional default value if provided, if no default value is provided returns undefined.

Type Parameters
NSV
Parameters
notSetValueNSV
Returns
T | NSV
Inherited from Collection.Set.first
first(): T | undefined
Returns
T | undefined
Inherited from Collection.Set.first

flatMap

flatMap<M>(
mapper: (value: T, key: T, iter: this) => Iterable<M>,
context?: unknown,
): NutrientViewer.Immutable.Set<M>
Flat-maps the Set, returning a new Set.

Similar to set.map(...).flatten(true).

Type Parameters
M
Parameters
mapper(value: T, key: T, iter: this) => Iterable<M>
contextunknown
Optional
Returns
NutrientViewer.Immutable.Set<M>
Overrides Collection.Set.flatMap

flatten

flatten(depth?: number): Collection<unknown, unknown>
Flattens nested Collections.

Will deeply flatten the Collection by default, returning a Collection of the same type, but a depth can be provided in the form of a number or boolean (where true means to shallowly flatten one level). A depth of 0 (or shallow: false) will deeply flatten.

Flattens only others Collection, not Arrays or Objects.

Note: flatten(true) operates on Collection<unknown, Collection<K, V>> and returns Collection<K, V>

Parameters
depthnumber
Optional
Returns
Collection<unknown, unknown>
Inherited from Collection.Set.flatten
flatten(shallow?: boolean): Collection<unknown, unknown>
Parameters
shallowboolean
Optional
Returns
Collection<unknown, unknown>
Inherited from Collection.Set.flatten

forEach

forEach(
sideEffect: (value: T, key: T, iter: this) => unknown,
context?: unknown,
): number
The sideEffect is executed for every entry in the Collection.

Unlike Array#forEach, if any call of sideEffect returns false, the iteration will stop. Returns the number of entries iterated (including the last iteration which returned false).

Parameters
sideEffect(value: T, key: T, iter: this) => unknown
contextunknown
Optional
Returns
number
Inherited from Collection.Set.forEach

groupBy

groupBy<G>(
grouper: (value: T, key: T, iter: this) => G,
context?: unknown,
): Map<G, NutrientViewer.Immutable.Set<T>>
Returns a Map of Collection, grouped by the return value of the grouper function.

Note: This is always an eager operation.

Type Parameters
G
Parameters
grouper(value: T, key: T, iter: this) => G
contextunknown
Optional
Returns
Map<G, NutrientViewer.Immutable.Set<T>>
Inherited from Collection.Set.groupBy

includes

includes(value: T): boolean
True if a value exists within this Collection, using Immutable.is to determine equality

Parameters
valueT
Returns
boolean
Inherited from Collection.Set.includes

intersect

intersect(...collections: Iterable<T, any, any>[]): this
Returns a Set which has removed any values not also contained within collections.

Note: intersect can be used in withMutations.

Parameters
...collectionsIterable<T, any, any>[]
Returns
this

isEmpty

isEmpty(): boolean
Returns true if this Collection includes no values.

For some lazy Seq, isEmpty might need to iterate to determine emptiness. At most one iteration will occur.

Returns
boolean
Inherited from Collection.Set.isEmpty

isSubset

isSubset(iter: Iterable<T>): boolean
True if iter includes every value in this Collection.

Parameters
iterIterable<T>
Returns
boolean
Inherited from Collection.Set.isSubset

isSuperset

isSuperset(iter: Iterable<T>): boolean
True if this Collection includes every value in iter.

Parameters
iterIterable<T>
Returns
boolean
Inherited from Collection.Set.isSuperset

join

join(separator?: string): string
Joins values together as a string, inserting a separator between each. The default separator is ",".

Parameters
separatorstring
Optional
Returns
string
Inherited from Collection.Set.join

keyOf

keyOf(searchValue: T): T | undefined
Returns the key associated with the search value, or undefined.

Parameters
searchValueT
Returns
T | undefined
Inherited from Collection.Set.keyOf

keys

keys(): IterableIterator<T>
An iterator of this Collection's keys.

Note: this will return an ES6 iterator which does not support Immutable.js sequence algorithms. Use keySeq instead, if this is what you want.

Returns
IterableIterator<T>
Inherited from Collection.Set.keys

keySeq

keySeq(): Indexed<T>
Returns a new Seq.Indexed of the keys of this Collection, discarding values.

Returns
Indexed<T>
Inherited from Collection.Set.keySeq

last

last<NSV>(notSetValue: NSV): T | NSV
In case the Collection is not empty returns the last element of the Collection. In case the Collection is empty returns the optional default value if provided, if no default value is provided returns undefined.

Type Parameters
NSV
Parameters
notSetValueNSV
Returns
T | NSV
Inherited from Collection.Set.last
last(): T | undefined
Returns
T | undefined
Inherited from Collection.Set.last

lastKeyOf

lastKeyOf(searchValue: T): T | undefined
Returns the last key associated with the search value, or undefined.

Parameters
searchValueT
Returns
T | undefined
Inherited from Collection.Set.lastKeyOf

map

map<M>(
mapper: (value: T, key: T, iter: this) => M,
context?: unknown,
): NutrientViewer.Immutable.Set<M>
Returns a new Set with values passed through a mapper function.
Set([1,2]).map(x => 10 * x) // Set [10,20]
Type Parameters
M
Parameters
mapper(value: T, key: T, iter: this) => M
contextunknown
Optional
Returns
NutrientViewer.Immutable.Set<M>
Overrides Collection.Set.map

max

max(comparator?: Comparator<T>): T | undefined
Returns the maximum value in this collection. If any values are comparatively equivalent, the first one found will be returned.

The comparator is used in the same way as Collection#sort. If it is not provided, the default comparator is >.

When two values are considered equivalent, the first encountered will be returned. Otherwise, max will operate independent of the order of input as long as the comparator is commutative. The default comparator > is commutative only when types do not differ.

If comparator returns 0 and either value is NaN, undefined, or null, that value will be returned.

Parameters
comparatorComparator<T>
Optional
Returns
T | undefined
Inherited from Collection.Set.max

maxBy

maxBy<C>(
comparatorValueMapper: (value: T, key: T, iter: this) => C,
comparator?: Comparator<C>,
): T | undefined
Like max, but also accepts a comparatorValueMapper which allows for comparing by more sophisticated means:

Type Parameters
C
Parameters
comparatorValueMapper(value: T, key: T, iter: this) => C
comparatorComparator<C>
Optional
Returns
T | undefined
Inherited from Collection.Set.maxBy

merge

merge<C>(
...collections: Iterable<C, any, any>[],
): NutrientViewer.Immutable.Set<T | C>
Type Parameters
C
Parameters
...collectionsIterable<C, any, any>[]
Returns
NutrientViewer.Immutable.Set<T | C>

min

min(comparator?: Comparator<T>): T | undefined
Returns the minimum value in this collection. If any values are comparatively equivalent, the first one found will be returned.

The comparator is used in the same way as Collection#sort. If it is not provided, the default comparator is <.

When two values are considered equivalent, the first encountered will be returned. Otherwise, min will operate independent of the order of input as long as the comparator is commutative. The default comparator < is commutative only when types do not differ.

If comparator returns 0 and either value is NaN, undefined, or null, that value will be returned.

Parameters
comparatorComparator<T>
Optional
Returns
T | undefined
Inherited from Collection.Set.min

minBy

minBy<C>(
comparatorValueMapper: (value: T, key: T, iter: this) => C,
comparator?: Comparator<C>,
): T | undefined
Like min, but also accepts a comparatorValueMapper which allows for comparing by more sophisticated means:

Type Parameters
C
Parameters
comparatorValueMapper(value: T, key: T, iter: this) => C
comparatorComparator<C>
Optional
Returns
T | undefined
Inherited from Collection.Set.minBy

partition

partition<F, C>(
predicate: (this: C, value: T, key: T, iter: this) => value is F,
context?: C,
): [NutrientViewer.Immutable.Set<T>, NutrientViewer.Immutable.Set<F>]
Returns a new Set with the values for which the predicate function returns false and another for which is returns true.

Type Parameters
F
C
Parameters
predicate(this: C, value: T, key: T, iter: this) => value is F
contextC
Optional
Returns
[NutrientViewer.Immutable.Set<T>, NutrientViewer.Immutable.Set<F>]
Overrides Collection.Set.partition
partition<C>(
predicate: (this: C, value: T, key: T, iter: this) => unknown,
context?: C,
): [NutrientViewer.Immutable.Set<T>, NutrientViewer.Immutable.Set<T>]
Returns a new set Collection with the values for which the predicate function returns false and another for which is returns true.

Type Parameters
C
Parameters
predicate(this: C, value: T, key: T, iter: this) => unknown
contextC
Optional
Returns
[NutrientViewer.Immutable.Set<T>, NutrientViewer.Immutable.Set<T>]
Overrides Collection.Set.partition

reduce

reduce(reducer: (reduction: T, value: T, key: T, iter: this) => T): T
Reduces the Collection to a value by calling the reducer for every entry in the Collection and passing along the reduced value.

If initialReduction is not provided, the first item in the Collection will be used.
Parameters
reducer(reduction: T, value: T, key: T, iter: this) => T
Returns
T
See Also
Array#reduce.
Inherited from Collection.Set.reduce
reduce<R>(
    reducer: (reduction: R, value: T, key: T, iter: this) => R,
    initialReduction: R,
    context?: unknown,
): R
Type Parameters
R
Parameters
reducer(reduction: R, value: T, key: T, iter: this) => R
initialReductionR
contextunknown
Optional
Returns
R
Inherited from Collection.Set.reduce
reduce<R>(reducer: (reduction: T | R, value: T, key: T, iter: this) => R): R
Type Parameters
R
Parameters
reducer(reduction: T | R, value: T, key: T, iter: this) => R
Returns
R
Inherited from Collection.Set.reduce

reduceRight

reduceRight(reducer: (reduction: T, value: T, key: T, iter: this) => T): T
Reduces the Collection in reverse (from the right side).

Note: Similar to this.reverse().reduce(), and provided for parity with Array#reduceRight.

Parameters
reducer(reduction: T, value: T, key: T, iter: this) => T
Returns
T
Inherited from Collection.Set.reduceRight
reduceRight<R>(
    reducer: (reduction: R, value: T, key: T, iter: this) => R,
    initialReduction: R,
    context?: unknown,
): R
Type Parameters
R
Parameters
reducer(reduction: R, value: T, key: T, iter: this) => R
initialReductionR
contextunknown
Optional
Returns
R
Inherited from Collection.Set.reduceRight
reduceRight<R>(
reducer: (reduction: T | R, value: T, key: T, iter: this) => R,
): R
Type Parameters
R
Parameters
reducer(reduction: T | R, value: T, key: T, iter: this) => R
Returns
R
Inherited from Collection.Set.reduceRight

remove

remove(value: T): this
Parameters
valueT
Returns
this

rest

rest(): this
Returns a new Collection of the same type containing all entries except the first.

Returns
this
Inherited from Collection.Set.rest

reverse

reverse(): this
Returns a new Collection of the same type in reverse order.

Returns
this
Inherited from Collection.Set.reverse

skip

skip(amount: number): this
Returns a new Collection of the same type which excludes the first amount entries from this Collection.

Parameters
amountnumber
Returns
this
Inherited from Collection.Set.skip

skipLast

skipLast(amount: number): this
Returns a new Collection of the same type which excludes the last amount entries from this Collection.

Parameters
amountnumber
Returns
this
Inherited from Collection.Set.skipLast

skipUntil

skipUntil(
predicate: (value: T, key: T, iter: this) => boolean,
context?: unknown,
): this
Returns a new Collection of the same type which includes entries starting from when predicate first returns true.

Parameters
predicate(value: T, key: T, iter: this) => boolean
contextunknown
Optional
Returns
this
Inherited from Collection.Set.skipUntil

skipWhile

skipWhile(
predicate: (value: T, key: T, iter: this) => boolean,
context?: unknown,
): this
Returns a new Collection of the same type which includes entries starting from when predicate first returns false.

Parameters
predicate(value: T, key: T, iter: this) => boolean
contextunknown
Optional
Returns
this
Inherited from Collection.Set.skipWhile

slice

slice(begin?: number, end?: number): this
Returns a new Collection of the same type representing a portion of this Collection from start up to but not including end.

If begin is negative, it is offset from the end of the Collection. e.g. slice(-2) returns a Collection of the last two entries. If it is not provided the new Collection will begin at the beginning of this Collection.

If end is negative, it is offset from the end of the Collection. e.g. slice(0, -1) returns a Collection of everything but the last entry. If it is not provided, the new Collection will continue through the end of this Collection.

If the requested slice is equivalent to the current Collection, then it will return itself.

Parameters
beginnumber
Optional
endnumber
Optional
Returns
this
Inherited from Collection.Set.slice

some

some(
predicate: (value: T, key: T, iter: this) => boolean,
context?: unknown,
): boolean
True if predicate returns true for any entry in the Collection.

Parameters
predicate(value: T, key: T, iter: this) => boolean
contextunknown
Optional
Returns
boolean
Inherited from Collection.Set.some

sort

sort(
comparator?: Comparator<T>,
): NutrientViewer.Immutable.Set<T> & OrderedSet<T>
Returns an OrderedSet of the same type which includes the same entries, stably sorted by using a comparator.

If a comparator is not provided, a default comparator uses < and >.

comparator(valueA, valueB):
- Returns 0 if the elements should not be swapped.
- Returns -1 (or any negative number) if valueA comes before valueB
- Returns 1 (or any positive number) if valueA comes after valueB
- Alternatively, can return a value of the PairSorting enum type
- Is pure, i.e. it must always return the same value for the same pair of values.
Note: sort() Always returns a new instance, even if the original was already sorted.

Note: This is always an eager operation.
Parameters
comparatorComparator<T>
Optional
Returns
NutrientViewer.Immutable.Set<T> & OrderedSet<T>
Overrides Collection.Set.sort

sortBy

sortBy<C>(
comparatorValueMapper: (value: T, key: T, iter: this) => C,
comparator?: (valueA: C, valueB: C) => number,
): NutrientViewer.Immutable.Set<T> & OrderedSet<T>
Like sort, but also accepts a comparatorValueMapper which allows for sorting by more sophisticated means:

Note: sortBy() Always returns a new instance, even if the original was already sorted.

Note: This is always an eager operation.

Type Parameters
C
Parameters
comparatorValueMapper(value: T, key: T, iter: this) => C
comparator(valueA: C, valueB: C) => number
Optional
Returns
NutrientViewer.Immutable.Set<T> & OrderedSet<T>
Overrides Collection.Set.sortBy

subtract

subtract(...collections: Iterable<T, any, any>[]): this
Returns a Set excluding any values contained within collections.

Note: subtract can be used in withMutations.

Parameters
...collectionsIterable<T, any, any>[]
Returns
this

take

take(amount: number): this
Returns a new Collection of the same type which includes the first amount entries from this Collection.

Parameters
amountnumber
Returns
this
Inherited from Collection.Set.take

takeLast

takeLast(amount: number): this
Returns a new Collection of the same type which includes the last amount entries from this Collection.

Parameters
amountnumber
Returns
this
Inherited from Collection.Set.takeLast

takeUntil

takeUntil(
predicate: (value: T, key: T, iter: this) => boolean,
context?: unknown,
): this
Returns a new Collection of the same type which includes entries from this Collection as long as the predicate returns false.

Parameters
predicate(value: T, key: T, iter: this) => boolean
contextunknown
Optional
Returns
this
Inherited from Collection.Set.takeUntil

takeWhile

takeWhile(
predicate: (value: T, key: T, iter: this) => boolean,
context?: unknown,
): this
Returns a new Collection of the same type which includes entries from this Collection as long as the predicate returns true.

Parameters
predicate(value: T, key: T, iter: this) => boolean
contextunknown
Optional
Returns
this
Inherited from Collection.Set.takeWhile

toArray

toArray(): T[]
Shallowly converts this collection to an Array.

Returns
T[]
Inherited from Collection.Set.toArray

toIndexedSeq

toIndexedSeq(): Indexed<T>
Returns an Seq.Indexed of the values of this Collection, discarding keys.

Returns
Indexed<T>
Inherited from Collection.Set.toIndexedSeq

toKeyedSeq

toKeyedSeq(): Keyed<T, T>
Returns a Seq.Keyed from this Collection where indices are treated as keys.

This is useful if you want to operate on an Collection.Indexed and preserve the [index, value] pairs.

The returned Seq will have identical iteration order as this Collection.

Returns
Keyed<T, T>
Inherited from Collection.Set.toKeyedSeq

toList

toList(): NutrientViewer.Immutable.List<T>
Converts this Collection to a List, discarding keys.

This is similar to List(collection), but provided to allow for chained expressions. However, when called on Map or other keyed collections, collection.toList() discards the keys and creates a list of only the values, whereas List(collection) creates a list of entry tuples.

Returns
NutrientViewer.Immutable.List<T>
Inherited from Collection.Set.toList

toMap

toMap(): Map<T, T>
Converts this Collection to a Map, Throws if keys are not hashable.

Note: This is equivalent to Map(this.toKeyedSeq()), but provided for convenience and to allow for chained expressions.

Returns
Map<T, T>
Inherited from Collection.Set.toMap

toOrderedMap

toOrderedMap(): OrderedMap<T, T>
Converts this Collection to a Map, maintaining the order of iteration.

Note: This is equivalent to OrderedMap(this.toKeyedSeq()), but provided for convenience and to allow for chained expressions.

Returns
OrderedMap<T, T>
Inherited from Collection.Set.toOrderedMap

toOrderedSet

toOrderedSet(): OrderedSet<T>
Converts this Collection to a Set, maintaining the order of iteration and discarding keys.

Note: This is equivalent to OrderedSet(this.valueSeq()), but provided for convenience and to allow for chained expressions.

Returns
OrderedSet<T>
Inherited from Collection.Set.toOrderedSet

toSet

toSet(): NutrientViewer.Immutable.Set<T>
Converts this Collection to a Set, discarding keys. Throws if values are not hashable.

Note: This is equivalent to Set(this), but provided to allow for chained expressions.

Returns
NutrientViewer.Immutable.Set<T>
Inherited from Collection.Set.toSet

toSetSeq

toSetSeq(): Set<T>
Returns a Seq.Set of the values of this Collection, discarding keys.

Returns
Set<T>
Inherited from Collection.Set.toSetSeq

toStack

toStack(): Stack<T>
Converts this Collection to a Stack, discarding keys. Throws if values are not hashable.

Note: This is equivalent to Stack(this), but provided to allow for chained expressions.

Returns
Stack<T>
Inherited from Collection.Set.toStack

union

union<C>(
...collections: Iterable<C, any, any>[],
): NutrientViewer.Immutable.Set<T | C>
Returns a Set including any value from collections that does not already exist in this Set.

Note: union can be used in withMutations.

Type Parameters
C
Parameters
...collectionsIterable<C, any, any>[]
Returns
NutrientViewer.Immutable.Set<T | C>

values

values(): IterableIterator<T>
An iterator of this Collection's values.

Note: this will return an ES6 iterator which does not support Immutable.js sequence algorithms. Use valueSeq instead, if this is what you want.

Returns
IterableIterator<T>
Inherited from Collection.Set.values

valueSeq

valueSeq(): Indexed<T>
Returns an Seq.Indexed of the values of this Collection, discarding keys.

Returns
Indexed<T>
Inherited from Collection.Set.valueSeq

wasAltered

wasAltered(): boolean
Returns
boolean
See Also
Map#wasAltered

withMutations

withMutations(mutator: (mutable: this) => unknown): this
Note: Not all methods can be used on a mutable collection or within withMutations! Check the documentation for each method to see if it mentions being safe to use in withMutations.
Parameters
mutator(mutable: this) => unknown
Returns
this
See Also
Map#withMutations

Immutable Record API

[iterator]

"[iterator]"(): IterableIterator<T>
Returns
IterableIterator<T>
Inherited from Collection.Set.[iterator]

equals

equals(other: unknown): boolean
True if this and the other Collection have value equality, as defined by Immutable.is().

Note: This is equivalent to Immutable.is(this, other), but provided to allow for chained expressions.

Parameters
otherunknown
Returns
boolean
Inherited from Collection.Set.equals

get

get<NSV>(key: T, notSetValue: NSV): T | NSV
Returns the value associated with the provided key, or notSetValue if the Collection does not contain this key.

Note: it is possible a key may be associated with an undefined value, so if notSetValue is not provided and this method returns undefined, that does not guarantee the key was not found.

Type Parameters
NSV
Parameters
keyT
notSetValueNSV
Returns
T | NSV
Inherited from Collection.Set.get
get(key: T): T | undefined
Parameters
keyT
Returns
T | undefined
Inherited from Collection.Set.get

getIn

getIn(searchKeyPath: Iterable<unknown>, notSetValue?: unknown): unknown
Returns the value found by following a path of keys or indices through nested Collections.

Plain JavaScript Object or Arrays may be nested within an Immutable.js Collection, and getIn() can access those values as well:

Parameters
searchKeyPathIterable<unknown>
notSetValueunknown
Optional
Returns
unknown
Inherited from Collection.Set.getIn

has

has(key: T): boolean
True if a key exists within this Collection, using Immutable.is to determine equality

Parameters
keyT
Returns
boolean
Inherited from Collection.Set.has

hashCode

hashCode(): number
Computes and returns the hashed identity for this Collection.

The hashCode of a Collection is used to determine potential equality, and is used when adding this to a Set or as a key in a Map, enabling lookup via a different instance.

If two values have the same hashCode, they are not guaranteed to be equal. If two values have different hashCodes, they must not be equal.

Returns
number
Inherited from Collection.Set.hashCode

hasIn

hasIn(searchKeyPath: Iterable<unknown>): boolean
True if the result of following a path of keys or indices through nested Collections results in a set value.

Parameters
searchKeyPathIterable<unknown>
Returns
boolean
Inherited from Collection.Set.hasIn

toJS

toJS(): DeepCopy<T>[]
Deeply converts this Set collection to equivalent native JavaScript Array.

Returns
DeepCopy<T>[]
Inherited from Collection.Set.toJS

toJSON

toJSON(): T[]
Shallowly converts this Set collection to equivalent native JavaScript Array.

Returns
T[]
Inherited from Collection.Set.toJSON

toObject

toObject(): { [key: string]: T }
Shallowly converts this Collection to an Object.

Converts keys to Strings.

Returns
{ [key: string]: T }
Inherited from Collection.Set.toObject

toSeq

toSeq(): Set<T>
Returns Seq.Set.

Returns
Set<T>
Inherited from Collection.Set.toSeq

update

update<R>(updater: (value: this) => R): R
This can be very useful as a way to "chain" a normal function into a sequence of methods. RxJS calls this "let" and lodash calls it "thru".

For example, to sum a Seq after mapping and filtering:

Type Parameters
R
Parameters
updater(value: this) => R
Returns
R
Inherited from Collection.Set.update

Interface Set

Type Parameters

Hierarchy

Properties

Methods

Parameters

Returns

Returns

See Also

Returns

See Also

Returns

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Type Parameters

Parameters

Returns

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Type Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns