A Collection of unique values with O(log32 N) adds and has.
type Set<T> extends Collection.Set<T>When iterating a Set, the entries will be (value, value) pairs. Iteration order of a Set is undefined, however is stable. Multiple iterations of the same Set will iterate in the same order.
Set values, like Map keys, may be of any type. Equality is determined using
Immutable.is, enabling Sets to uniquely include other Immutable
collections, custom value types, and NaN.
Set.isSet(maybeSet: unknown): boolean
Set.fromKeys<T>(iter: Collection.Keyed<T, unknown>): Set<T>
Set.fromKeys<T>(iter: Collection<T, unknown>): Set<T>
Set.fromKeys(obj: {[key: string]: unknown}): Set<string>
Set.intersect<T>(sets: Iterable<Iterable<T>>): Set<T>
Set.union<T>(sets: Iterable<Iterable<T>>): Set<T>
The number of items in this Set.
size: numberReturns a new Set which also includes this value.
add(value: T): this
Note: add can be used in withMutations.
Returns a new Set which excludes this value.
delete(value: T): this
remove()Note: delete can be used in withMutations.
Note: delete cannot be safely used in IE8, use remove if
supporting old browsers.
Returns a new Set containing no values.
clear(): this
Note: clear can be used in withMutations.
Returns a Set including any value from collections that does not already
exist in this Set.
union<C>(...collections: Array<Iterable<C>>): Set<T | C>
merge()concat()Note: union can be used in withMutations.
Returns a Set which has removed any values not also contained
within collections.
intersect(...collections: Array<Iterable<T>>): this
Note: intersect can be used in withMutations.
Returns a Set excluding any values contained within collections.
subtract(...collections: Array<Iterable<T>>): this
const { OrderedSet } = require('immutable')
OrderedSet([ 1, 2, 3 ]).subtract([1, 3])
// OrderedSet [2]run it
Note: subtract can be used in withMutations.
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".
update<R>(updater: (value: this) => R): R
Collection#update()For example, to sum a Seq after mapping and filtering:
const { Seq } = require('immutable')
function sum(collection) {
return collection.reduce((sum, x) => sum + x, 0)
}
Seq([ 1, 2, 3 ])
.map(x => x + 1)
.filter(x => x % 2 === 0)
.update(sum)
// 6run it
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.
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.
asMutable(): this
wasAltered(): boolean
asImmutable(): this
Returns a new Set with values passed through a
mapper function.
map<M>(mapper: (value: T, key: T, iter: this) => M, context?: unknown): Set<M>
Collection.Set#map()Set([1,2]).map(x => 10 * x)
// Set [10,20]Flat-maps the Set, returning a new Set.
flatMap<M>(mapper: (value: T, key: T, iter: this) => Iterable<M>,
context?: unknown): Set<M>
Collection.Set#flatMap()Similar to set.map(...).flatten(true).
filter<F>(predicate: (value: T, key: T, iter: this) => boolean,
context?: unknown): Set<F>
filter(predicate: (value: T, key: T, iter: this) => unknown,
context?: unknown): this
Collection.Set#filter()partition<F, C>(predicate: (this: C, value: T, key: T, iter: this) => boolean,
context?: C): [Set<T>, Set<F>]
partition<C>(predicate: (this: C, value: T, key: T, iter: this) => unknown,
context?: C): [this, this]
Collection.Set#partition()Returns an OrderedSet of the same type which includes the same entries,
stably sorted by using a comparator.
sort(comparator?: Comparator<T>): this & OrderedSet<T>
Collection#sort()If a comparator is not provided, a default comparator uses < and >.
comparator(valueA, valueB):
0 if the elements should not be swapped.-1 (or any negative number) if valueA comes before valueB1 (or any positive number) if valueA comes after valueBPairSorting enum typeconst { Set } = require('immutable')
Set(['b', 'a', 'c']).sort((a, b) => {
if (a < b) { return -1; }
if (a > b) { return 1; }
if (a === b) { return 0; }
});
// OrderedSet { "a":, "b", "c" }run itNote: sort() Always returns a new instance, even if the original was
already sorted.
Note: This is always an eager operation.
Like sort, but also accepts a comparatorValueMapper which allows for
sorting by more sophisticated means:
sortBy<C>(comparatorValueMapper: (value: T, key: T, iter: this) => C,
comparator?: (valueA: C, valueB: C) => number): this & OrderedSet<T>
Collection#sortBy()const { Set } = require('immutable')
const beattles = Set([
{ name: "Lennon" },
{ name: "McCartney" },
{ name: "Harrison" },
{ name: "Starr" },
]);
beattles.sortBy(member => member.name);run it
Note: sortBy() Always returns a new instance, even if the original was
already sorted.
Note: This is always an eager operation.
Returns a new Collection with other collections concatenated to this one.
concat<U>(...collections: Array<Iterable<U>>): Collection.Set<T | U>
Collection.Set#concat()[Symbol.iterator](): IterableIterator<T>
Collection.Set#[Symbol.iterator]()Returns a new Collection of the same type with only the entries for which
the predicate function returns false.
filterNot(predicate: (value: T, key: T, iter: this) => boolean,
context?: unknown): this
Collection#filterNot()const { Map } = require('immutable')
Map({ a: 1, b: 2, c: 3, d: 4}).filterNot(x => x % 2 === 0)
// Map { "a": 1, "c": 3 }run it
Note: filterNot() always returns a new instance, even if it results in
not filtering out any values.
Returns a new Collection of the same type in reverse order.
reverse(): this
Collection#reverse()Returns a Map of Collection, grouped by the return
value of the grouper function.
groupBy<G>(grouper: (value: T, key: T, iter: this) => G,
context?: unknown): Map<G, this>
Collection#groupBy()Note: This is always an eager operation.
const { List, Map } = require('immutable')
const listOfMaps = List([
Map({ v: 0 }),
Map({ v: 1 }),
Map({ v: 1 }),
Map({ v: 0 }),
Map({ v: 2 })
])
const groupsOfMaps = listOfMaps.groupBy(x => x.get('v'))
// Map {
// 0: List [ Map{ "v": 0 }, Map { "v": 0 } ],
// 1: List [ Map{ "v": 1 }, Map { "v": 1 } ],
// 2: List [ Map{ "v": 2 } ],
// }run itDeeply converts this Set collection to equivalent native JavaScript Array.
toJS(): Array<DeepCopy<T>>
Collection.Set#toJS()Shallowly converts this Set collection to equivalent native JavaScript Array.
toJSON(): Array<T>
Collection.Set#toJSON()Shallowly converts this collection to an Array.
toArray(): Array<T>
Collection.Set#toArray()Shallowly converts this Collection to an Object.
toObject(): {[key: string]: T}
Collection#toObject()Converts keys to Strings.
Returns a Seq.Keyed from this Collection where indices are treated as keys.
toKeyedSeq(): Seq.Keyed<T, T>
Collection#toKeyedSeq()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.
const { Seq } = require('immutable')
const indexedSeq = Seq([ 'A', 'B', 'C' ])
// Seq [ "A", "B", "C" ]
indexedSeq.filter(v => v === 'B')
// Seq [ "B" ]
const keyedSeq = indexedSeq.toKeyedSeq()
// Seq { 0: "A", 1: "B", 2: "C" }
keyedSeq.filter(v => v === 'B')
// Seq { 1: "B" }run itReturns an Seq.Indexed of the values of this Collection, discarding keys.
toIndexedSeq(): Seq.Indexed<T>
Collection#toIndexedSeq()Returns a Seq.Set of the values of this Collection, discarding keys.
toSetSeq(): Seq.Set<T>
Collection#toSetSeq()True if this and the other Collection have value equality, as defined
by Immutable.is().
equals(other: unknown): boolean
Collection#equals()Note: This is equivalent to Immutable.is(this, other), but provided to
allow for chained expressions.
Computes and returns the hashed identity for this Collection.
hashCode(): number
Collection#hashCode()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.
const a = List([ 1, 2, 3 ]);
const b = List([ 1, 2, 3 ]);
assert.notStrictEqual(a, b); // different instances
const set = Set([ a ]);
assert.equal(set.has(b), true);run itIf two values have the same hashCode, they are not guaranteed
to be equal. If two values have different hashCodes,
they must not be equal.
get<NSV>(key: T, notSetValue: NSV): T | NSV
get(key: T): T | undefined
Collection#get()True if a key exists within this Collection, using Immutable.is
to determine equality
has(key: T): boolean
Collection#has()True if a value exists within this Collection, using Immutable.is
to determine equality
includes(value: T): boolean
Collection#includes()contains()first<NSV>(notSetValue: NSV): T | NSV
first(): T | undefined
Collection#first()last<NSV>(notSetValue: NSV): T | NSV
last(): T | undefined
Collection#last()Returns the value found by following a path of keys or indices through nested Collections.
getIn(searchKeyPath: Iterable<unknown>, notSetValue?: unknown): unknown
Collection#getIn()const { Map, List } = require('immutable')
const deepData = Map({ x: List([ Map({ y: 123 }) ]) });
deepData.getIn(['x', 0, 'y']) // 123run it
Plain JavaScript Object or Arrays may be nested within an Immutable.js Collection, and getIn() can access those values as well:
const { Map, List } = require('immutable')
const deepData = Map({ x: [ { y: 123 } ] });
deepData.getIn(['x', 0, 'y']) // 123run it
True if the result of following a path of keys or indices through nested Collections results in a set value.
hasIn(searchKeyPath: Iterable<unknown>): boolean
Collection#hasIn()Converts this Collection to a Map, Throws if keys are not hashable.
toMap(): Map<T, T>
Collection#toMap()Note: This is equivalent to Map(this.toKeyedSeq()), but provided
for convenience and to allow for chained expressions.
Converts this Collection to a Map, maintaining the order of iteration.
toOrderedMap(): OrderedMap<T, T>
Collection#toOrderedMap()Note: This is equivalent to OrderedMap(this.toKeyedSeq()), but
provided for convenience and to allow for chained expressions.
Converts this Collection to a Set, discarding keys. Throws if values are not hashable.
toSet(): Set<T>
Collection#toSet()Note: This is equivalent to Set(this), but provided to allow for
chained expressions.
Converts this Collection to a Set, maintaining the order of iteration and discarding keys.
toOrderedSet(): OrderedSet<T>
Collection#toOrderedSet()Note: This is equivalent to OrderedSet(this.valueSeq()), but provided
for convenience and to allow for chained expressions.
Converts this Collection to a List, discarding keys.
toList(): List<T>
Collection#toList()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.
const { Map, List } = require('immutable')
var myMap = Map({ a: 'Apple', b: 'Banana' })
List(myMap) // List [ [ "a", "Apple" ], [ "b", "Banana" ] ]
myMap.toList() // List [ "Apple", "Banana" ]run itConverts this Collection to a Stack, discarding keys. Throws if values are not hashable.
toStack(): Stack<T>
Collection#toStack()Note: This is equivalent to Stack(this), but provided to allow for
chained expressions.
An iterator of this Collection's keys.
keys(): IterableIterator<T>
Collection#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.
An iterator of this Collection's values.
values(): IterableIterator<T>
Collection#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.
An iterator of this Collection's entries as [ key, value ] tuples.
entries(): IterableIterator<[T, T]>
Collection#entries()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 a new Seq.Indexed of the keys of this Collection, discarding values.
keySeq(): Seq.Indexed<T>
Collection#keySeq()Returns an Seq.Indexed of the values of this Collection, discarding keys.
valueSeq(): Seq.Indexed<T>
Collection#valueSeq()Returns a new Seq.Indexed of [key, value] tuples.
entrySeq(): Seq.Indexed<[T, T]>
Collection#entrySeq()The sideEffect is executed for every entry in the Collection.
forEach(sideEffect: (value: T, key: T, iter: this) => unknown,
context?: unknown): number
Collection#forEach()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).
Returns a new Collection of the same type representing a portion of this Collection from start up to but not including end.
slice(begin?: number, end?: number): this
Collection#slice()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.
Returns a new Collection of the same type containing all entries except the first.
rest(): this
Collection#rest()Returns a new Collection of the same type containing all entries except the last.
butLast(): this
Collection#butLast()Returns a new Collection of the same type which excludes the first amount
entries from this Collection.
skip(amount: number): this
Collection#skip()Returns a new Collection of the same type which excludes the last amount
entries from this Collection.
skipLast(amount: number): this
Collection#skipLast()Returns a new Collection of the same type which includes entries starting
from when predicate first returns false.
skipWhile(predicate: (value: T, key: T, iter: this) => boolean,
context?: unknown): this
Collection#skipWhile()const { List } = require('immutable')
List([ 'dog', 'frog', 'cat', 'hat', 'god' ])
.skipWhile(x => x.match(/g/))
// List [ "cat", "hat", "god" ]run it
Returns a new Collection of the same type which includes entries starting
from when predicate first returns true.
skipUntil(predicate: (value: T, key: T, iter: this) => boolean,
context?: unknown): this
Collection#skipUntil()const { List } = require('immutable')
List([ 'dog', 'frog', 'cat', 'hat', 'god' ])
.skipUntil(x => x.match(/hat/))
// List [ "hat", "god" ]run it
Returns a new Collection of the same type which includes the first amount
entries from this Collection.
take(amount: number): this
Collection#take()Returns a new Collection of the same type which includes the last amount
entries from this Collection.
takeLast(amount: number): this
Collection#takeLast()Returns a new Collection of the same type which includes entries from this
Collection as long as the predicate returns true.
takeWhile(predicate: (value: T, key: T, iter: this) => boolean,
context?: unknown): this
Collection#takeWhile()const { List } = require('immutable')
List([ 'dog', 'frog', 'cat', 'hat', 'god' ])
.takeWhile(x => x.match(/o/))
// List [ "dog", "frog" ]run it
Returns a new Collection of the same type which includes entries from this
Collection as long as the predicate returns false.
takeUntil(predicate: (value: T, key: T, iter: this) => boolean,
context?: unknown): this
Collection#takeUntil()const { List } = require('immutable')
List([ 'dog', 'frog', 'cat', 'hat', 'god' ])
.takeUntil(x => x.match(/at/))
// List [ "dog", "frog" ]run it
flatten(depth?: number): Collection<unknown, unknown>
flatten(shallow?: boolean): Collection<unknown, unknown>
Collection#flatten()reduce<R>(reducer: (reduction: R, value: T, key: T, iter: this) => R,
initialReduction: R,
context?: unknown): R
reduce<R>(reducer: (reduction: T | R, value: T, key: T, iter: this) => R): R
Collection#reduce()reduceRight<R>(reducer: (reduction: R, value: T, key: T, iter: this) => R,
initialReduction: R,
context?: unknown): R
reduceRight<R>(reducer: (reduction: T | R, value: T, key: T, iter: this) => R): R
Collection#reduceRight()True if predicate returns true for all entries in the Collection.
every(predicate: (value: T, key: T, iter: this) => boolean,
context?: unknown): boolean
Collection#every()True if predicate returns true for any entry in the Collection.
some(predicate: (value: T, key: T, iter: this) => boolean,
context?: unknown): boolean
Collection#some()Joins values together as a string, inserting a separator between each.
The default separator is ",".
join(separator?: string): string
Collection#join()Returns true if this Collection includes no values.
isEmpty(): boolean
Collection#isEmpty()count(): number
count(predicate: (value: T, key: T, iter: this) => boolean,
context?: unknown): number
Collection#count()Returns a Seq.Keyed of counts, grouped by the return value of
the grouper function.
countBy<G>(grouper: (value: T, key: T, iter: this) => G,
context?: unknown): Map<G, number>
Collection#countBy()Note: This is not a lazy operation.
Returns the first value for which the predicate returns true.
find(predicate: (value: T, key: T, iter: this) => boolean,
context?: unknown,
notSetValue?: T): T | undefined
Collection#find()Returns the last value for which the predicate returns true.
findLast(predicate: (value: T, key: T, iter: this) => boolean,
context?: unknown,
notSetValue?: T): T | undefined
Collection#findLast()Note: predicate will be called for each entry in reverse.
Returns the first [key, value] entry for which the predicate returns true.
findEntry(predicate: (value: T, key: T, iter: this) => boolean,
context?: unknown,
notSetValue?: T): [T, T] | undefined
Collection#findEntry()Returns the last [key, value] entry for which the predicate
returns true.
findLastEntry(predicate: (value: T, key: T, iter: this) => boolean,
context?: unknown,
notSetValue?: T): [T, T] | undefined
Collection#findLastEntry()Note: predicate will be called for each entry in reverse.
Returns the key for which the predicate returns true.
findKey(predicate: (value: T, key: T, iter: this) => boolean,
context?: unknown): T | undefined
Collection#findKey()Returns the last key for which the predicate returns true.
findLastKey(predicate: (value: T, key: T, iter: this) => boolean,
context?: unknown): T | undefined
Collection#findLastKey()Note: predicate will be called for each entry in reverse.
Returns the key associated with the search value, or undefined.
keyOf(searchValue: T): T | undefined
Collection#keyOf()Returns the last key associated with the search value, or undefined.
lastKeyOf(searchValue: T): T | undefined
Collection#lastKeyOf()Returns the maximum value in this collection. If any values are comparatively equivalent, the first one found will be returned.
max(comparator?: Comparator<T>): T | undefined
Collection#max()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.
Like max, but also accepts a comparatorValueMapper which allows for
comparing by more sophisticated means:
maxBy<C>(comparatorValueMapper: (value: T, key: T, iter: this) => C,
comparator?: Comparator<C>): T | undefined
Collection#maxBy()const { List, } = require('immutable');
const l = List([
{ name: 'Bob', avgHit: 1 },
{ name: 'Max', avgHit: 3 },
{ name: 'Lili', avgHit: 2 } ,
]);
l.maxBy(i => i.avgHit); // will output { name: 'Max', avgHit: 3 }run it
Returns the minimum value in this collection. If any values are comparatively equivalent, the first one found will be returned.
min(comparator?: Comparator<T>): T | undefined
Collection#min()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.
Like min, but also accepts a comparatorValueMapper which allows for
comparing by more sophisticated means:
minBy<C>(comparatorValueMapper: (value: T, key: T, iter: this) => C,
comparator?: Comparator<C>): T | undefined
Collection#minBy()const { List, } = require('immutable');
const l = List([
{ name: 'Bob', avgHit: 1 },
{ name: 'Max', avgHit: 3 },
{ name: 'Lili', avgHit: 2 } ,
]);
l.minBy(i => i.avgHit); // will output { name: 'Bob', avgHit: 1 }run it
True if iter includes every value in this Collection.
isSubset(iter: Iterable<T>): boolean
Collection#isSubset()True if this Collection includes every value in iter.
isSuperset(iter: Iterable<T>): boolean
Collection#isSuperset()