Immutable.js Flashcards
(191 cards)
1
Q
List
Create a new immutable _____ containing the values of the provided iterable-like.
\_\_\_\_\_<T>():\_\_\_\_\_<T>\_\_\_\_\_<T>(iter: IndexedIterable<T>):\_\_\_\_\_<T>\_\_\_\_\_<T>(iter: SetIterable<T>):\_\_\_\_\_<T>\_\_\_\_\_<K, V>(iter: KeyedIterable<K, V>):\_\_\_\_\_<any>\_\_\_\_\_<T>(array: Array<T>):\_\_\_\_\_<T>\_\_\_\_\_<T>(iterator: Iterator<T>):\_\_\_\_\_<T>\_\_\_\_\_<T>(iterable: Object):\_\_\_\_\_<T>
1 construction methods.
A
List
Create a new immutable List containing the values of the provided iterable-like.
List<T>(): List<T>List<T>(iter: IndexedIterable<T>): List<T>List<T>(iter: SetIterable<T>): List<T>List<K, V>(iter: KeyedIterable<K, V>): List<any>List<T>(array: Array<T>): List<T>List<T>(iterator: Iterator<T>): List<T>List<T>(iterable: Object): List<T>
2
Q
List
True if the provided value is a List
List.isList(maybeList: any): boolean
2 static methods methods.
A
List.isList
True if the provided value is a List
List.isList(maybeList: any): boolean
3
Q
List
Creates a new List containing values.
List.of<T>(...values: T[]): List<T>
2 static methods methods.
A
List.of
Creates a new List containing values.
List.of<T>(...values: T[]): List<T>
4
Q
List
Returns a new List which includes value at index. If index already exists in this List, it will be replaced.
\_\_\_\_\_(index: number, value: T): List<T>
13 persistent changes methods.
A
set
Returns a new List which includes value at index. If index already exists in this List, it will be replaced.
set(index: number, value: T): List<T>
5
Q
List
Returns a new List which excludes this index and with a size 1 less than this List. Values at indicies above index are shifted down by 1 to fill the position.
\_\_\_\_\_(index: number): List<T>
13 persistent changes methods.
A
delete
Returns a new List which excludes this index and with a size 1 less than this List. Values at indicies above index are shifted down by 1 to fill the position.
delete(index: number): List<T>
6
Q
List
Returns a new List with 0 size and no values.
\_\_\_\_\_(): List<T>
13 persistent changes methods.
A
clear
Returns a new List with 0 size and no values.
clear(): List<T>
7
Q
List
Returns a new List with the provided values appended, starting at this List’s size.
\_\_\_\_\_(...values: T[]): List<T>
13 persistent changes methods.
A
push
Returns a new List with the provided values appended, starting at this List’s size.
push(...values: T[]): List<T>
8
Q
List
Returns a new List with a size ones less than this List, excluding the last index in this List.
\_\_\_\_\_(): List<T>
13 persistent changes methods.
A
pop
Returns a new List with a size ones less than this List, excluding the last index in this List.
pop(): List<T>
9
Q
List
Returns a new List with the provided values prepended, shifting other values ahead to higher indices.
\_\_\_\_\_(...values: T[]): List<T>
13 persistent changes methods.
A
unshift
Returns a new List with the provided values prepended, shifting other values ahead to higher indices.
unshift(...values: T[]): List<T>
10
Q
List
Returns a new List with a size ones less than this List, excluding the first index in this List, _____ing all other values to a lower index.
\_\_\_\_\_(): List<T>
13 persistent changes methods.
A
shift
Returns a new List with a size ones less than this List, excluding the first index in this List, shifting all other values to a lower index.
shift(): List<T>
11
Q
List
Returns a new List with an _____d value at index with the return value of calling \_\_\_\_\_r with the existing value, or notSetValue if index was not set. If called with a single argument, \_\_\_\_\_r is called with the List itself.
\_\_\_\_\_(\_\_\_\_\_r: (value: List<T>) => List<T>): List<T>\_\_\_\_\_(index: number,\_\_\_\_\_r: (value: T) => T): List<T>\_\_\_\_\_(index: number, notSetValue: T,\_\_\_\_\_r: (value: T) => T): List<T>
13 persistent changes methods.
A
update
Returns a new List with an updated value at index with the return value of calling updater with the existing value, or notSetValue if index was not set. If called with a single argument, updater is called with the List itself.
update(updater: (value: List<T>) => List<T>): List<T>update(index: number, updater: (value: T) => T): List<T>update(index: number, notSetValue: T, updater: (value: T) => T): List<T>
12
Q
List\_\_\_\_\_(...iterables: IndexedIterable<T>[]): List<T>\_\_\_\_\_(...iterables: Array<T>[]): List<T>
13 persistent changes methods.
A
mergemerge(...iterables: IndexedIterable<T>[]): List<T>merge(...iterables: Array<T>[]): List<T>
13
Q
List
`_____(
merger: (previous?: T, next?: T, key?: number) => T,…iterables: IndexedIterable<T>[]</T>
): List<T>\_\_\_\_\_(
merger: (previous?: T, next?: T, key?: number) => T,...iterables: Array<T>[]</T></T>
): List<T>`</T>
13 persistent changes methods.
A
mergeWith
`mergeWith(
merger: (previous?: T, next?: T, key?: number) => T,…iterables: IndexedIterable<T>[]</T>
): List<T>mergeWith(
merger: (previous?: T, next?: T, key?: number) => T,...iterables: Array<T>[]</T></T>
): List<T>`</T>
14
Q
List\_\_\_\_\_(...iterables: IndexedIterable<T>[]): List<T>\_\_\_\_\_(...iterables: Array<T>[]): List<T>
13 persistent changes methods.
A
mergeDeepmergeDeep(...iterables: IndexedIterable<T>[]): List<T>mergeDeep(...iterables: Array<T>[]): List<T>
15
Q
List
`_____(
merger: (previous?: T, next?: T, key?: number) => T,…iterables: IndexedIterable<T>[]</T>
): List<T>\_\_\_\_\_(
merger: (previous?: T, next?: T, key?: number) => T,...iterables: Array<T>[]</T></T>
): List<T>`</T>
13 persistent changes methods.
A
mergeDeepWith
`mergeDeepWith(
merger: (previous?: T, next?: T, key?: number) => T,…iterables: IndexedIterable<T>[]</T>
): List<T>mergeDeepWith(
merger: (previous?: T, next?: T, key?: number) => T,...iterables: Array<T>[]</T></T>
): List<T>`</T>
16
Q
List
Returns a new List with size size. If size is less than this List’s size, the new List will exclude values at the higher indices. If size is greater than this List’s size, the new List will have undefined values for the newly available indices.
\_\_\_\_\_(size: number): List<T>
13 persistent changes methods.
A
setSize
Returns a new List with size size. If size is less than this List’s size, the new List will exclude values at the higher indices. If size is greater than this List’s size, the new List will have undefined values for the newly available indices.
setSize(size: number): List<T>
17
Q
List
Returns a new List having set value at this keyPath. If any keys in keyPath do not exist, a new immutable Map will be created at that key.
\_\_\_\_\_(keyPath: Array<any>, value: any): List<T>\_\_\_\_\_(keyPath: Iterable<any, any>, value: any): List<T>
5 deep persistent changes methods.
A
setIn
Returns a new List having set value at this keyPath. If any keys in keyPath do not exist, a new immutable Map will be created at that key.
setIn(keyPath: Array<any>, value: any): List<T>setIn(keyPath: Iterable<any, any>, value: any): List<T>
18
Q
List
Returns a new List having removed the value at this keyPath. If any keys in keyPath do not exist, no change will occur.
\_\_\_\_\_(keyPath: Array<any>): List<T>\_\_\_\_\_(keyPath: Iterable<any, any>): List<T>
5 deep persistent changes methods.
A
deleteIn
Returns a new List having removed the value at this keyPath. If any keys in keyPath do not exist, no change will occur.
deleteIn(keyPath: Array<any>): List<T>deleteIn(keyPath: Iterable<any, any>): List<T>
19
Q
List
`_____(keyPath: Array<any>, updater: (value: any) => any): List<T>\_\_\_\_\_(
keyPath: Array<any>,notSetValue: any,updater: (value: any) => any</any></T></any>
): List<T>\_\_\_\_\_(keyPath: Iterable<any, any>, updater: (value: any) => any): List<T>\_\_\_\_\_(
keyPath: Iterable<any, any>,notSetValue: any,updater: (value: any) => any</T></T>
): List<T>`</T>
5 deep persistent changes methods.
A
updateIn
`updateIn(keyPath: Array<any>, updater: (value: any) => any): List<T>updateIn(
keyPath: Array<any>,notSetValue: any,updater: (value: any) => any</any></T></any>
): List<T>updateIn(keyPath: Iterable<any, any>, updater: (value: any) => any): List<T>updateIn(
keyPath: Iterable<any, any>,notSetValue: any,updater: (value: any) => any</T></T>
): List<T>`</T>
20
Q
List
`_____(
keyPath: Iterable<any, any>,…iterables: IndexedIterable<T>[]</T>
): List<T>\_\_\_\_\_(keyPath: Array<any>, ...iterables: IndexedIterable<T>[]): List<T>\_\_\_\_\_(keyPath: Array<any>, ...iterables: Array<T>[]): List<T>`</T></T></any></T></T></any></T>
5 deep persistent changes methods.
A
mergeIn
`mergeIn(
keyPath: Iterable<any, any>,…iterables: IndexedIterable<T>[]</T>
): List<T>mergeIn(keyPath: Array<any>, ...iterables: IndexedIterable<T>[]): List<T>mergeIn(keyPath: Array<any>, ...iterables: Array<T>[]): List<T>`</T></T></any></T></T></any></T>
21
Q
List
`_____(
keyPath: Iterable<any, any>,…iterables: IndexedIterable<T>[]</T>
): List<T>\_\_\_\_\_(keyPath: Array<any>, ...iterables: IndexedIterable<T>[]): List<T>\_\_\_\_\_(keyPath: Array<any>, ...iterables: Array<T>[]): List<T>`</T></T></any></T></T></any></T>
5 deep persistent changes methods.
A
mergeDeepIn
`mergeDeepIn(
keyPath: Iterable<any, any>,…iterables: IndexedIterable<T>[]</T>
): List<T>mergeDeepIn(keyPath: Array<any>, ...iterables: IndexedIterable<T>[]): List<T>mergeDeepIn(keyPath: Array<any>, ...iterables: Array<T>[]): List<T>`</T></T></any></T></T></any></T>
22
Q
List
Note: Not all methods can be used on a mutable collection or within \_\_\_\_\_! Only set, push, pop, shift, unshift and merge may be used mutatively.
\_\_\_\_\_(mutator: (mutable: List<T>) => any): List<T>
3 transient changes methods.
A
withMutations
Note: Not all methods can be used on a mutable collection or within withMutations! Only set, push, pop, shift, unshift and merge may be used mutatively.
withMutations(mutator: (mutable: List<T>) => any): List<T>
23
Q
List\_\_\_\_\_(): List<T>
3 transient changes methods.
A
asMutableasMutable(): List<T>
24
Q
List\_\_\_\_\_(): List<T>
3 transient changes methods.
A
asImmutableasImmutable(): List<T>
25
Map
Creates a new Immutable \_\_\_\_\_.
`_____():__________(iter: KeyedIterable):__________(iter: Iterable>):__________(array: Array>):__________(obj: {[key: string]: V}):__________(iterator: Iterator>):__________(iterable: Object):_____`
*1 construction methods.*
Map
Creates a new Immutable Map.
`Map(): MapMap(iter: KeyedIterable): MapMap(iter: Iterable>): MapMap(array: Array>): MapMap(obj: {[key: string]: V}): MapMap(iterator: Iterator>): MapMap(iterable: Object): Map`
26
Map
True if the provided value is a Map
`Map.isMap(maybeMap: any): boolean`
*1 static methods methods.*
Map.isMap
True if the provided value is a Map
`Map.isMap(maybeMap: any): boolean`
27
Map
Returns a new Map also containing the new key, value pair. If an equivalent key already exists in this Map, it will be replaced.
`_____(key: K, value: V): Map`
*8 persistent changes methods.*
set
Returns a new Map also containing the new key, value pair. If an equivalent key already exists in this Map, it will be replaced.
`set(key: K, value: V): Map`
28
Map
Returns a new Map which excludes this `key`.
`_____(key: K): Map`
*8 persistent changes methods.*
delete
Returns a new Map which excludes this `key`.
`delete(key: K): Map`
29
Map
Returns a new Map containing no keys or values.
`_____(): Map`
*8 persistent changes methods.*
clear
Returns a new Map containing no keys or values.
`clear(): Map`
30
Map
Returns a new Map having \_\_\_\_\_d the value at this `key` with the return value of calling `_____r` with the existing value, or `notSetValue` if the key was not set. If called with only a single argument, `_____r` is called with the Map itself.
`_____(_____r: (value: Map) => Map): Map_____(key: K,_____r: (value: V) => V): Map_____(key: K, notSetValue: V,_____r: (value: V) => V): Map`
*8 persistent changes methods.*
update
Returns a new Map having updated the value at this `key` with the return value of calling `updater` with the existing value, or `notSetValue` if the key was not set. If called with only a single argument, `updater` is called with the Map itself.
`update(updater: (value: Map) => Map): Mapupdate(key: K, updater: (value: V) => V): Mapupdate(key: K, notSetValue: V, updater: (value: V) => V): Map`
31
Map
Returns a new Map resulting from merging the provided Iterables (or JS objects) into this Map. In other words, this takes each entry of each iterable and sets it on this Map.
`_____(...iterables: Iterable[]): Map_____(...iterables: {[key: string]: V}[]): Map`
*8 persistent changes methods.*
merge
Returns a new Map resulting from merging the provided Iterables (or JS objects) into this Map. In other words, this takes each entry of each iterable and sets it on this Map.
`merge(...iterables: Iterable[]): Mapmerge(...iterables: {[key: string]: V}[]): Map`
32
Map
Like `merge()`, `_____()` returns a new Map resulting from merging the provided Iterables (or JS objects) into this Map, but uses the `merger` function for dealing with conflicts.
`_____(
merger: (previous?: V, next?: V, key?: K) => V,...iterables: Iterable[]
): Map_____(
merger: (previous?: V, next?: V, key?: K) => V,...iterables: {[key: string]: V}[]
): Map`
*8 persistent changes methods.*
mergeWith
Like `merge()`, `mergeWith()` returns a new Map resulting from merging the provided Iterables (or JS objects) into this Map, but uses the `merger` function for dealing with conflicts.
`mergeWith(
merger: (previous?: V, next?: V, key?: K) => V,...iterables: Iterable[]
): MapmergeWith(
merger: (previous?: V, next?: V, key?: K) => V,...iterables: {[key: string]: V}[]
): Map`
33
Map
Like `merge()`, but when two Iterables conflict, it merges them as well, recursing deeply through the nested data.
`_____(...iterables: Iterable[]): Map_____(...iterables: {[key: string]: V}[]): Map`
*8 persistent changes methods.*
mergeDeep
Like `merge()`, but when two Iterables conflict, it merges them as well, recursing deeply through the nested data.
`mergeDeep(...iterables: Iterable[]): MapmergeDeep(...iterables: {[key: string]: V}[]): Map`
34
Map
Like `mergeDeep()`, but when two non-Iterables conflict, it uses the `merger` function to determine the resulting value.
`_____(
merger: (previous?: V, next?: V, key?: K) => V,...iterables: Iterable[]
): Map_____(
merger: (previous?: V, next?: V, key?: K) => V,...iterables: {[key: string]: V}[]
): Map`
*8 persistent changes methods.*
mergeDeepWith
Like `mergeDeep()`, but when two non-Iterables conflict, it uses the `merger` function to determine the resulting value.
`mergeDeepWith(
merger: (previous?: V, next?: V, key?: K) => V,...iterables: Iterable[]
): MapmergeDeepWith(
merger: (previous?: V, next?: V, key?: K) => V,...iterables: {[key: string]: V}[]
): Map`
35
Map
Returns a new Map having set `value` at this `keyPath`. If any keys in `keyPath` do not exist, a new immutable Map will be created at that key.
`_____(keyPath: Array, value: any): Map_____(KeyPath: Iterable, value: any): Map`
*5 deep persistent changes methods.*
setIn
Returns a new Map having set `value` at this `keyPath`. If any keys in `keyPath` do not exist, a new immutable Map will be created at that key.
`setIn(keyPath: Array, value: any): MapsetIn(KeyPath: Iterable, value: any): Map`
36
Map
Returns a new Map having removed the value at this `keyPath`. If any keys in `keyPath` do not exist, no change will occur.
`_____(keyPath: Array): Map_____(keyPath: Iterable): Map`
*5 deep persistent changes methods.*
deleteIn
Returns a new Map having removed the value at this `keyPath`. If any keys in `keyPath` do not exist, no change will occur.
`deleteIn(keyPath: Array): MapdeleteIn(keyPath: Iterable): Map`
37
Map
Returns a new Map having applied the `updater` to the entry found at the keyPath.
`_____(keyPath: Array, updater: (value: any) => any): Map_____(
keyPath: Array,notSetValue: any,updater: (value: any) => any
): Map_____(keyPath: Iterable, updater: (value: any) => any): Map_____(
keyPath: Iterable,notSetValue: any,updater: (value: any) => any
): Map`
*5 deep persistent changes methods.*
updateIn
Returns a new Map having applied the `updater` to the entry found at the keyPath.
`updateIn(keyPath: Array, updater: (value: any) => any): MapupdateIn(
keyPath: Array,notSetValue: any,updater: (value: any) => any
): MapupdateIn(keyPath: Iterable, updater: (value: any) => any): MapupdateIn(
keyPath: Iterable,notSetValue: any,updater: (value: any) => any
): Map`
38
Map
A combination of `updateIn` and `merge`, returning a new Map, but performing the merge at a point arrived at by following the keyPath. In other words, these two lines are equivalent:
`_____(keyPath: Iterable, ...iterables: Iterable[]): Map_____(keyPath: Array, ...iterables: Iterable[]): Map_____(keyPath: Array, ...iterables: {[key: string]: V}[]): Map`
*5 deep persistent changes methods.*
mergeIn
A combination of `updateIn` and `merge`, returning a new Map, but performing the merge at a point arrived at by following the keyPath. In other words, these two lines are equivalent:
`mergeIn(keyPath: Iterable, ...iterables: Iterable[]): MapmergeIn(keyPath: Array, ...iterables: Iterable[]): MapmergeIn(keyPath: Array, ...iterables: {[key: string]: V}[]): Map`
39
Map
A combination of `updateIn` and `mergeDeep`, returning a new Map, but performing the deep merge at a point arrived at by following the keyPath. In other words, these two lines are equivalent:
`_____(
keyPath: Iterable,...iterables: Iterable[]
): Map_____(keyPath: Array, ...iterables: Iterable[]): Map_____(
keyPath: Array,...iterables: {[key: string]: V}[]
): Map`
*5 deep persistent changes methods.*
mergeDeepIn
A combination of `updateIn` and `mergeDeep`, returning a new Map, but performing the deep merge at a point arrived at by following the keyPath. In other words, these two lines are equivalent:
`mergeDeepIn(
keyPath: Iterable,...iterables: Iterable[]
): MapmergeDeepIn(keyPath: Array, ...iterables: Iterable[]): MapmergeDeepIn(
keyPath: Array,...iterables: {[key: string]: V}[]
): Map`
40
Map
Every time you call one of the above functions, a new immutable Map is created. If a pure function calls a number of these to produce a final return value, then a penalty on performance and memory has been paid by creating all of the intermediate immutable Maps.
`_____(mutator: (mutable: Map) => any): Map`
*3 transient changes methods.*
withMutations
Every time you call one of the above functions, a new immutable Map is created. If a pure function calls a number of these to produce a final return value, then a penalty on performance and memory has been paid by creating all of the intermediate immutable Maps.
`withMutations(mutator: (mutable: Map) => any): Map`
41
Map
Another way to avoid creation of intermediate Immutable maps is to create a mutable copy of this collection. Mutable copies *always* return `this`, and thus shouldn't be used for equality. Your function should never return a mutable copy of a collection, only use it internally to create a new collection. If possible, use `withMutations` as it provides an easier to use API.
`_____(): Map`
*3 transient changes methods.*
asMutable
Another way to avoid creation of intermediate Immutable maps is to create a mutable copy of this collection. Mutable copies *always* return `this`, and thus shouldn't be used for equality. Your function should never return a mutable copy of a collection, only use it internally to create a new collection. If possible, use `withMutations` as it provides an easier to use API.
`asMutable(): Map`
42
Map
The yin to `asMutable`'s yang. Because it applies to mutable collections, this operation is *mutable* and returns itself. Once performed, the mutable copy has become immutable and can be safely returned from a function.
`_____(): Map`
*3 transient changes methods.*
asImmutable
The yin to `asMutable`'s yang. Because it applies to mutable collections, this operation is *mutable* and returns itself. Once performed, the mutable copy has become immutable and can be safely returned from a function.
`asImmutable(): Map`
43
OrderedMap
Creates a new Immutable \_\_\_\_\_.
`_____():__________(iter: KeyedIterable):__________(iter: Iterable>):__________(array: Array>):__________(obj: {[key: string]: V}):__________(iterator: Iterator>):__________(iterable: Object):_____`
*1 construction methods.*
OrderedMap
Creates a new Immutable OrderedMap.
`OrderedMap(): OrderedMapOrderedMap(iter: KeyedIterable): OrderedMapOrderedMap(iter: Iterable>): OrderedMapOrderedMap(array: Array>): OrderedMapOrderedMap(obj: {[key: string]: V}): OrderedMapOrderedMap(iterator: Iterator>): OrderedMapOrderedMap(iterable: Object): OrderedMap`
44
OrderedMap
True if the provided value is an OrderedMap.
`OrderedMap.isOrderedMap(maybeOrderedMap: any): boolean`
*1 static methods methods.*
OrderedMap.isOrderedMap
True if the provided value is an OrderedMap.
`OrderedMap.isOrderedMap(maybeOrderedMap: any): boolean`
45
Set
Create a new immutable _____ containing the values of the provided iterable-like.
`_____():__________(iter:_____Iterable): __________(iter: IndexedIterable): __________(iter: KeyedIterable): __________(array: Array): __________(iterator: Iterator): __________(iterable: Object): _____`
*1 construction methods.*
Set
Create a new immutable Set containing the values of the provided iterable-like.
`Set(): SetSet(iter: SetIterable): SetSet(iter: IndexedIterable): SetSet(iter: KeyedIterable): SetSet(array: Array): SetSet(iterator: Iterator): SetSet(iterable: Object): Set`
46
Set
True if the provided value is a Set
`Set.isSet(maybeSet: any): boolean`
*3 static methods methods.*
Set.isSet
True if the provided value is a Set
`Set.isSet(maybeSet: any): boolean`
47
Set
Creates a new Set containing `values`.
`Set.of(...values: T[]): Set`
*3 static methods methods.*
Set.of
Creates a new Set containing `values`.
`Set.of(...values: T[]): Set`
48
Set
`Set.fromKeys()` creates a new immutable Set containing the keys from this Iterable or JavaScript Object.
`Set.fromKeys(iter: Iterable): SetSet.fromKeys(obj: {[key: string]: any}): Set`
*3 static methods methods.*
Set.fromKeys
`Set.fromKeys()` creates a new immutable Set containing the keys from this Iterable or JavaScript Object.
`Set.fromKeys(iter: Iterable): SetSet.fromKeys(obj: {[key: string]: any}): Set`
49
Set
Returns a new Set which also includes this value.
`_____(value: T): Set`
*6 persistent changes methods.*
add
Returns a new Set which also includes this value.
`add(value: T): Set`
50
Set
Returns a new Set which excludes this value.
`_____(value: T): Set`
*6 persistent changes methods.*
delete
Returns a new Set which excludes this value.
`delete(value: T): Set`
51
Set
Returns a new Set containing no values.
`_____(): Set`
*6 persistent changes methods.*
clear
Returns a new Set containing no values.
`clear(): Set`
52
Set
Returns a Set including any value from `iterables` that does not already exist in this Set.
`_____(...iterables: Iterable[]): Set_____(...iterables: Array[]): Set`
*6 persistent changes methods.*
union
Returns a Set including any value from `iterables` that does not already exist in this Set.
`union(...iterables: Iterable[]): Setunion(...iterables: Array[]): Set`
53
Set
Returns a Set which has removed any values not also contained within `iterables`.
`_____(...iterables: Iterable[]): Set_____(...iterables: Array[]): Set`
*6 persistent changes methods.*
intersect
Returns a Set which has removed any values not also contained within `iterables`.
`intersect(...iterables: Iterable[]): Setintersect(...iterables: Array[]): Set`
54
Set
Returns a Set excluding any values contained within `iterables`.
`_____(...iterables: Iterable[]): Set_____(...iterables: Array[]): Set`
*6 persistent changes methods.*
subtract
Returns a Set excluding any values contained within `iterables`.
`subtract(...iterables: Iterable[]): Setsubtract(...iterables: Array[]): Set`
55
Set
Note: Not all methods can be used on a mutable collection or within `_____`! Only `add` may be used mutatively.
`_____(mutator: (mutable: Set) => any): Set`
*3 transient changes methods.*
withMutations
Note: Not all methods can be used on a mutable collection or within `withMutations`! Only `add` may be used mutatively.
`withMutations(mutator: (mutable: Set) => any): Set`
56
Set
`_____(): Set`
*3 transient changes methods.*
asMutable
`asMutable(): Set`
57
Set
`_____(): Set`
*3 transient changes methods.*
asImmutable
`asImmutable(): Set`
58
OrderedSet
Create a new immutable _____ containing the values of the provided iterable-like.
`_____():__________(iter: SetIterable):__________(iter: IndexedIterable):__________(iter: KeyedIterable):__________(array: Array):__________(iterator: Iterator):__________(iterable: Object):_____`
*1 construction methods.*
OrderedSet
Create a new immutable OrderedSet containing the values of the provided iterable-like.
`OrderedSet(): OrderedSetOrderedSet(iter: SetIterable): OrderedSetOrderedSet(iter: IndexedIterable): OrderedSetOrderedSet(iter: KeyedIterable): OrderedSetOrderedSet(array: Array): OrderedSetOrderedSet(iterator: Iterator): OrderedSetOrderedSet(iterable: Object): OrderedSet`
59
OrderedSet
True if the provided value is an OrderedSet.
`OrderedSet.isOrderedSet(maybeOrderedSet: any): boolean`
*3 static methods methods.*
OrderedSet.isOrderedSet
True if the provided value is an OrderedSet.
`OrderedSet.isOrderedSet(maybeOrderedSet: any): boolean`
60
OrderedSet
Creates a new OrderedSet containing `values`.
`OrderedSet.of(...values: T[]): OrderedSet`
*3 static methods methods.*
OrderedSet.of
Creates a new OrderedSet containing `values`.
`OrderedSet.of(...values: T[]): OrderedSet`
61
OrderedSet
`OrderedSet.fromKeys()` creates a new immutable OrderedSet containing the keys from this Iterable or JavaScript Object.
`OrderedSet.fromKeys(iter: Iterable): OrderedSetOrderedSet.fromKeys(obj: {[key: string]: any}): OrderedSet`
*3 static methods methods.*
OrderedSet.fromKeys
`OrderedSet.fromKeys()` creates a new immutable OrderedSet containing the keys from this Iterable or JavaScript Object.
`OrderedSet.fromKeys(iter: Iterable): OrderedSetOrderedSet.fromKeys(obj: {[key: string]: any}): OrderedSet`
62
Stack
Create a new immutable _____ containing the values of the provided iterable-like.
`_____():__________(iter: IndexedIterable):__________(iter: SetIterable):__________(iter: KeyedIterable):__________(array: Array):__________(iterator: Iterator):__________(iterable: Object):_____`
*1 construction methods.*
Stack
Create a new immutable Stack containing the values of the provided iterable-like.
`Stack(): StackStack(iter: IndexedIterable): StackStack(iter: SetIterable): StackStack(iter: KeyedIterable): StackStack(array: Array): StackStack(iterator: Iterator): StackStack(iterable: Object): Stack`
63
Stack
True if the provided value is a Stack
`Stack.isStack(maybeStack: any): boolean`
*2 static methods methods.*
Stack.isStack
True if the provided value is a Stack
`Stack.isStack(maybeStack: any): boolean`
64
Stack
Creates a new Stack containing `values`.
`Stack.of(...values: T[]): Stack`
*2 static methods methods.*
Stack.of
Creates a new Stack containing `values`.
`Stack.of(...values: T[]): Stack`
65
Stack
Alias for `Stack.first()`.
`_____(): T`
*6 reading values methods.*
peek
Alias for `Stack.first()`.
`peek(): T`
66
Stack
Returns a new Stack with 0 size and no values.
`_____(): Stack`
*7 persistent changes methods.*
clear
Returns a new Stack with 0 size and no values.
`clear(): Stack`
67
Stack
Returns a new Stack with the provided `values` prepended, shifting other values ahead to higher indices.
`_____(...values: T[]): Stack`
*7 persistent changes methods.*
unshift
Returns a new Stack with the provided `values` prepended, shifting other values ahead to higher indices.
`unshift(...values: T[]): Stack`
68
Stack
Like `Stack#unshift`, but accepts a iterable rather than varargs.
`_____(iter: Iterable): Stack_____(iter: Array): Stack`
*7 persistent changes methods.*
unshiftAll
Like `Stack#unshift`, but accepts a iterable rather than varargs.
`unshiftAll(iter: Iterable): StackunshiftAll(iter: Array): Stack`
69
Stack
Returns a new Stack with a size ones less than this Stack, excluding the first item in this Stack, \_\_\_\_\_ing all other values to a lower index.
`_____(): Stack`
*7 persistent changes methods.*
shift
Returns a new Stack with a size ones less than this Stack, excluding the first item in this Stack, shifting all other values to a lower index.
`shift(): Stack`
70
Stack
Alias for `Stack#unshift` and is not equivalent to `List#_____`.
`_____(...values: T[]): Stack`
*7 persistent changes methods.*
push
Alias for `Stack#unshift` and is not equivalent to `List#push`.
`push(...values: T[]): Stack`
71
Stack
Alias for `Stack#unshiftAll`.
`_____(iter: Iterable): Stack_____(iter: Array): Stack`
*7 persistent changes methods.*
pushAll
Alias for `Stack#unshiftAll`.
`pushAll(iter: Iterable): StackpushAll(iter: Array): Stack`
72
Stack
Alias for `Stack#shift` and is not equivalent to `List#_____`.
`_____(): Stack`
*7 persistent changes methods.*
pop
Alias for `Stack#shift` and is not equivalent to `List#pop`.
`pop(): Stack`
73
Stack
Note: Not all methods can be used on a mutable collection or within `_____`! Only `set`, `push`, and `pop` may be used mutatively.
`_____(mutator: (mutable: Stack) => any): Stack`
*3 transient changes methods.*
withMutations
Note: Not all methods can be used on a mutable collection or within `withMutations`! Only `set`, `push`, and `pop` may be used mutatively.
`withMutations(mutator: (mutable: Stack) => any): Stack`
74
Stack
`_____(): Stack`
*3 transient changes methods.*
asMutable
`asMutable(): Stack`
75
Stack
`_____(): Stack`
*3 transient changes methods.*
asImmutable
`asImmutable(): Stack`
76
Record
`_____(defaultValues: {[key: string]: any}, name?: string):_____.Class`
*1 construction methods.*
Record
`Record(defaultValues: {[key: string]: any}, name?: string): Record.Class`
77
Seq
Creates a \_\_\_\_\_.
`_____():__________(seq:_____): __________(iterable: Iterable): __________(array: Array): Indexed__________(obj: {[key: string]: V}): Keyed__________(iterator: Iterator): Indexed__________(iterable: Object): Indexed_____`
*1 construction methods.*
Seq
Creates a Seq.
`Seq(): SeqSeq(seq: Seq): SeqSeq(iterable: Iterable): SeqSeq(array: Array): IndexedSeqSeq(obj: {[key: string]: V}): KeyedSeqSeq(iterator: Iterator): IndexedSeqSeq(iterable: Object): IndexedSeq`
78
Seq
True if `maybeSeq` is a Seq, it is not backed by a concrete structure such as Map, List, or Set.
`Seq.isSeq(maybeSeq: any): boolean`
*2 static methods methods.*
Seq.isSeq
True if `maybeSeq` is a Seq, it is not backed by a concrete structure such as Map, List, or Set.
`Seq.isSeq(maybeSeq: any): boolean`
79
Seq
Returns a _____ the values provided. Alias for `Indexed_____()`.
`Seq.of(...values: T[]): IndexedSeq`
*2 static methods methods.*
Seq.of
Returns a Seq of the values provided. Alias for `IndexedSeq.of()`.
`Seq.of(...values: T[]): IndexedSeq`
80
Seq
`_____ze: number`
*1 members methods.*
si
`size: number`
81
Seq
Because Sequences are lazy and designed to be chained together, they do not cache their results. For example, this map function is called a total of 6 times, as each `join` iterates the Seq of three values.
`_____(): Seq`
*1 force evaluation methods.*
cacheResult
Because Sequences are lazy and designed to be chained together, they do not cache their results. For example, this map function is called a total of 6 times, as each `join` iterates the Seq of three values.
`cacheResult(): Seq`
82
KeyedSeq
Always returns a \_\_\_\_\_, if input is not keyed, expects an iterable of [K, V] tuples.
`_____():__________(seq: KeyedIterable):__________(seq: Iterable):__________(array: Array):__________(obj: {[key: string]: V}):__________(iterator: Iterator):__________(iterable: Object):_____`
*1 construction methods.*
KeyedSeq
Always returns a KeyedSeq, if input is not keyed, expects an iterable of [K, V] tuples.
`KeyedSeq(): KeyedSeqKeyedSeq(seq: KeyedIterable): KeyedSeqKeyedSeq(seq: Iterable): KeyedSeqKeyedSeq(array: Array): KeyedSeqKeyedSeq(obj: {[key: string]: V}): KeyedSeqKeyedSeq(iterator: Iterator): KeyedSeqKeyedSeq(iterable: Object): KeyedSeq`
83
KeyedSeq
Returns itself
`_____(): KeyedSeq`
*4 conversion to seq methods.*
toSeq
Returns itself
`toSeq(): KeyedSeq`
84
IndexedSeq
Always returns \_\_\_\_\_, discarding associated keys and supplying incrementing indices.
`_____():__________(seq: IndexedIterable):__________(seq: SetIterable):__________(seq: KeyedIterable):__________(array: Array):__________(iterator: Iterator):__________(iterable: Object):_____`
*1 construction methods.*
IndexedSeq
Always returns IndexedSeq, discarding associated keys and supplying incrementing indices.
`IndexedSeq(): IndexedSeqIndexedSeq(seq: IndexedIterable): IndexedSeqIndexedSeq(seq: SetIterable): IndexedSeqIndexedSeq(seq: KeyedIterable): IndexedSeqIndexedSeq(array: Array): IndexedSeqIndexedSeq(iterator: Iterator): IndexedSeqIndexedSeq(iterable: Object): IndexedSeq`
85
IndexedSeq
Provides an _____ the values provided.
`IndexedSeq.of(...values: T[]): IndexedSeq`
*1 static methods methods.*
IndexedSeq.of
Provides an IndexedSeq of the values provided.
`IndexedSeq.of(...values: T[]): IndexedSeq`
86
IndexedSeq
Returns itself
`_____(): IndexedSeq`
*5 conversion to seq methods.*
toSeq
Returns itself
`toSeq(): IndexedSeq`
87
SetSeq
Always returns a \_\_\_\_\_, discarding associated indices or keys.
`_____():__________(seq: SetIterable):__________(seq: IndexedIterable):__________(seq: KeyedIterable):__________(array: Array):__________(iterator: Iterator):__________(iterable: Object):_____`
*1 construction methods.*
SetSeq
Always returns a SetSeq, discarding associated indices or keys.
`SetSeq(): SetSeqSetSeq(seq: SetIterable): SetSeqSetSeq(seq: IndexedIterable): SetSeqSetSeq(seq: KeyedIterable): SetSeqSetSeq(array: Array): SetSeqSetSeq(iterator: Iterator): SetSeqSetSeq(iterable: Object): SetSeq`
88
SetSeq
Returns a _____ the provided values
`SetSeq.of(...values: T[]): SetSeq`
*1 static methods methods.*
SetSeq.of
Returns a SetSeq of the provided values
`SetSeq.of(...values: T[]): SetSeq`
89
SetSeq
Returns itself
`_____(): SetSeq`
*4 conversion to seq methods.*
toSeq
Returns itself
`toSeq(): SetSeq`
90
Iterable
Creates an \_\_\_\_\_.
`_____(iterable:_____): __________(array: Array): Indexed__________(obj: {[key: string]: V}): Keyed__________(iterator: Iterator): Indexed__________(iterable: Object): Indexed__________(value: V): Indexed_____`
*1 construction methods.*
Iterable
Creates an Iterable.
`Iterable(iterable: Iterable): IterableIterable(array: Array): IndexedIterableIterable(obj: {[key: string]: V}): KeyedIterableIterable(iterator: Iterator): IndexedIterableIterable(iterable: Object): IndexedIterableIterable(value: V): IndexedIterable`
91
Iterable
True if `maybeIterable` is an Iterable, or any of its subclasses.
`Iterable.isIterable(maybeIterable: any): boolean`
*5 static methods methods.*
Iterable.isIterable
True if `maybeIterable` is an Iterable, or any of its subclasses.
`Iterable.isIterable(maybeIterable: any): boolean`
92
Iterable
True if `maybeKeyed` is a KeyedIterable, or any of its subclasses.
`Iterable.isKeyed(maybeKeyed: any): boolean`
*5 static methods methods.*
Iterable.isKeyed
True if `maybeKeyed` is a KeyedIterable, or any of its subclasses.
`Iterable.isKeyed(maybeKeyed: any): boolean`
93
Iterable
True if `maybeIndexed` is a IndexedIterable, or any of its subclasses.
`Iterable.isIndexed(maybeIndexed: any): boolean`
*5 static methods methods.*
Iterable.isIndexed
True if `maybeIndexed` is a IndexedIterable, or any of its subclasses.
`Iterable.isIndexed(maybeIndexed: any): boolean`
94
Iterable
True if `maybeAssociative` is either a keyed or indexed Iterable.
`Iterable.isAssociative(maybeAssociative: any): boolean`
*5 static methods methods.*
Iterable.isAssociative
True if `maybeAssociative` is either a keyed or indexed Iterable.
`Iterable.isAssociative(maybeAssociative: any): boolean`
95
Iterable
True if `maybeOrdered` is an Iterable where iteration order is well defined. True for IndexedIterable as well as OrderedMap and OrderedSet.
`Iterable.isOrdered(maybeOrdered: any): boolean`
*5 static methods methods.*
Iterable.isOrdered
True if `maybeOrdered` is an Iterable where iteration order is well defined. True for IndexedIterable as well as OrderedMap and OrderedSet.
`Iterable.isOrdered(maybeOrdered: any): boolean`
96
Iterable
True if this and the other Iterable have value equality, as defined by `Immutable.is()`.
`_____(other: Iterable): boolean`
*2 value equality methods.*
equals
True if this and the other Iterable have value equality, as defined by `Immutable.is()`.
`equals(other: Iterable): boolean`
97
Iterable
Computes and returns the hashed identity for this Iterable.
`_____(): number`
*2 value equality methods.*
hashCode
Computes and returns the hashed identity for this Iterable.
`hashCode(): number`
98
Iterable
Returns the value associated with the provided key, or notSetValue if the Iterable does not contain this key.
`_____(key: K, notSetValue?: V): V`
*5 reading values methods.*
get
Returns the value associated with the provided key, or notSetValue if the Iterable does not contain this key.
`get(key: K, notSetValue?: V): V`
99
Iterable
True if a key exists within this `Iterable`.
`_____(key: K): boolean`
*5 reading values methods.*
has
True if a key exists within this `Iterable`.
`has(key: K): boolean`
100
Iterable
True if a value exists within this `Iterable`.
`_____(value: V): boolean`
*5 reading values methods.*
includes
True if a value exists within this `Iterable`.
`includes(value: V): boolean`
101
Iterable
The _____ value in the Iterable.
`_____(): V`
*5 reading values methods.*
first
The first value in the Iterable.
`first(): V`
102
Iterable
The _____ value in the Iterable.
`_____(): V`
*5 reading values methods.*
last
The last value in the Iterable.
`last(): V`
103
Iterable
Returns the value found by following a path of keys or indices through nested Iterables.
`_____(searchKeyPath: Array, notSetValue?: any): any_____(searchKeyPath: Iterable, notSetValue?: any): any`
*2 reading deep values methods.*
getIn
Returns the value found by following a path of keys or indices through nested Iterables.
`getIn(searchKeyPath: Array, notSetValue?: any): anygetIn(searchKeyPath: Iterable, notSetValue?: any): any`
104
Iterable
True if the result of following a path of keys or indices through nested Iterables results in a set value.
`_____(searchKeyPath: Array): boolean_____(searchKeyPath: Iterable): boolean`
*2 reading deep values methods.*
hasIn
True if the result of following a path of keys or indices through nested Iterables results in a set value.
`hasIn(searchKeyPath: Array): booleanhasIn(searchKeyPath: Iterable): boolean`
105
Iterable
Deeply converts this Iterable to equivalent JS.
`_____(): any`
*3 conversion to javascript types methods.*
toJS
Deeply converts this Iterable to equivalent JS.
`toJS(): any`
106
Iterable
Shallowly converts this iterable to an Array, discarding keys.
`_____(): Array`
*3 conversion to javascript types methods.*
toArray
Shallowly converts this iterable to an Array, discarding keys.
`toArray(): Array`
107
Iterable
Shallowly converts this Iterable to an Object.
`_____(): {[key: string]: V}`
*3 conversion to javascript types methods.*
toObject
Shallowly converts this Iterable to an Object.
`toObject(): {[key: string]: V}`
108
Iterable
Converts this Iterable to a Map, Throws if keys are not hashable.
`_____(): Map`
*6 conversion to collections methods.*
toMap
Converts this Iterable to a Map, Throws if keys are not hashable.
`toMap(): Map`
109
Iterable
Converts this Iterable to a Map, maintaining the order of iteration.
`_____(): Map`
*6 conversion to collections methods.*
toOrderedMap
Converts this Iterable to a Map, maintaining the order of iteration.
`toOrderedMap(): Map`
110
Iterable
Converts this Iterable to a Set, discarding keys. Throws if values are not hashable.
`_____(): Set`
*6 conversion to collections methods.*
toSet
Converts this Iterable to a Set, discarding keys. Throws if values are not hashable.
`toSet(): Set`
111
Iterable
Converts this Iterable to a Set, maintaining the order of iteration and discarding keys.
`_____(): Set`
*6 conversion to collections methods.*
toOrderedSet
Converts this Iterable to a Set, maintaining the order of iteration and discarding keys.
`toOrderedSet(): Set`
112
Iterable
Converts this Iterable to a List, discarding keys.
`_____(): List`
*6 conversion to collections methods.*
toList
Converts this Iterable to a List, discarding keys.
`toList(): List`
113
Iterable
Converts this Iterable to a Stack, discarding keys. Throws if values are not hashable.
`_____(): Stack`
*6 conversion to collections methods.*
toStack
Converts this Iterable to a Stack, discarding keys. Throws if values are not hashable.
`toStack(): Stack`
114
Iterable
Converts this Iterable to a Seq of the same kind (indexed, keyed, or set).
`_____(): Seq`
*4 conversion to seq methods.*
toSeq
Converts this Iterable to a Seq of the same kind (indexed, keyed, or set).
`toSeq(): Seq`
115
Iterable
Returns a KeyedSeq from this Iterable where indices are treated as keys.
`_____(): KeyedSeq`
*4 conversion to seq methods.*
toKeyedSeq
Returns a KeyedSeq from this Iterable where indices are treated as keys.
`toKeyedSeq(): KeyedSeq`
116
Iterable
Returns an IndexedSeq of the values of this Iterable, discarding keys.
`_____(): IndexedSeq`
*4 conversion to seq methods.*
toIndexedSeq
Returns an IndexedSeq of the values of this Iterable, discarding keys.
`toIndexedSeq(): IndexedSeq`
117
Iterable
Returns a SetSeq of the values of this Iterable, discarding keys.
`_____(): SetSeq`
*4 conversion to seq methods.*
toSetSeq
Returns a SetSeq of the values of this Iterable, discarding keys.
`toSetSeq(): SetSeq`
118
Iterable
An iterator of this `Iterable`'s \_\_\_\_\_.
`_____(): Iterator`
*3 iterators methods.*
keys
An iterator of this `Iterable`'s keys.
`keys(): Iterator`
119
Iterable
An iterator of this `Iterable`'s \_\_\_\_\_.
`_____(): Iterator`
*3 iterators methods.*
values
An iterator of this `Iterable`'s values.
`values(): Iterator`
120
Iterable
An iterator of this `Iterable`'s _____ as `[key, value]` tuples.
`_____(): Iterator>`
*3 iterators methods.*
entries
An iterator of this `Iterable`'s entries as `[key, value]` tuples.
`entries(): Iterator>`
121
Iterable
Returns a new IndexedSeq of the keys of this Iterable, discarding values.
`_____(): IndexedSeq`
*3 iterables (seq) methods.*
keySeq
Returns a new IndexedSeq of the keys of this Iterable, discarding values.
`keySeq(): IndexedSeq`
122
Iterable
Returns an IndexedSeq of the values of this Iterable, discarding keys.
`_____(): IndexedSeq`
*3 iterables (seq) methods.*
valueSeq
Returns an IndexedSeq of the values of this Iterable, discarding keys.
`valueSeq(): IndexedSeq`
123
Iterable
Returns a new IndexedSeq of [key, value] tuples.
`_____(): IndexedSeq>`
*3 iterables (seq) methods.*
entrySeq
Returns a new IndexedSeq of [key, value] tuples.
`entrySeq(): IndexedSeq>`
124
Iterable
Returns a new Iterable of the same type with values passed through a `_____per` function.
`_____(
_____per: (value?: V, key?: K, iter?: Iterable) => M,context?: any
): Iterable`
*7 sequence algorithms methods.*
map
Returns a new Iterable of the same type with values passed through a `mapper` function.
`map(
mapper: (value?: V, key?: K, iter?: Iterable) => M,context?: any
): Iterable`
125
Iterable
Returns a new Iterable of the same type with only the entries for which the `predicate` function returns true.
`_____(
predicate: (value?: V, key?: K, iter?: Iterable) => boolean,context?: any
): Iterable`
*7 sequence algorithms methods.*
filter
Returns a new Iterable of the same type with only the entries for which the `predicate` function returns true.
`filter(
predicate: (value?: V, key?: K, iter?: Iterable) => boolean,context?: any
): Iterable`
126
Iterable
Returns a new Iterable of the same type with only the entries for which the `predicate` function returns false.
`_____(
predicate: (value?: V, key?: K, iter?: Iterable) => boolean,context?: any
): Iterable`
*7 sequence algorithms methods.*
filterNot
Returns a new Iterable of the same type with only the entries for which the `predicate` function returns false.
`filterNot(
predicate: (value?: V, key?: K, iter?: Iterable) => boolean,context?: any
): Iterable`
127
Iterable
Returns a new Iterable of the same type in _____ order.
`_____(): Iterable`
*7 sequence algorithms methods.*
reverse
Returns a new Iterable of the same type in reverse order.
`reverse(): Iterable`
128
Iterable
Returns a new Iterable of the same type which includes the same entries, stably \_\_\_\_\_ed by using a `comparator`.
`_____(comparator?: (valueA: V, valueB: V) => number): Iterable`
*7 sequence algorithms methods.*
sort
Returns a new Iterable of the same type which includes the same entries, stably sorted by using a `comparator`.
`sort(comparator?: (valueA: V, valueB: V) => number): Iterable`
129
Iterable
Like `sort`, but also accepts a `comparatorValueMapper` which allows for sorting by more sophisticated means:
`_____(
comparatorValueMapper: (value?: V, key?: K, iter?: Iterable) => C,comparator?: (valueA: C, valueB: C) => number
): Iterable`
*7 sequence algorithms methods.*
sortBy
Like `sort`, but also accepts a `comparatorValueMapper` which allows for sorting by more sophisticated means:
`sortBy(
comparatorValueMapper: (value?: V, key?: K, iter?: Iterable) => C,comparator?: (valueA: C, valueB: C) => number
): Iterable`
130
Iterable
Returns a `KeyedIterable` of `KeyedIterables`, grouped by the return value of the `grouper` function.
`_____(
grouper: (value?: V, key?: K, iter?: Iterable) => G,context?: any
): KeyedSeq>`
*7 sequence algorithms methods.*
groupBy
Returns a `KeyedIterable` of `KeyedIterables`, grouped by the return value of the `grouper` function.
`groupBy(
grouper: (value?: V, key?: K, iter?: Iterable) => G,context?: any
): KeyedSeq>`
131
Iterable
The `sideEffect` is executed for every entry in the Iterable.
`_____(
sideEffect: (value?: V, key?: K, iter?: Iterable) => any,context?: any
): number`
*1 side effects methods.*
forEach
The `sideEffect` is executed for every entry in the Iterable.
`forEach(
sideEffect: (value?: V, key?: K, iter?: Iterable) => any,context?: any
): number`
132
Iterable
Returns a new Iterable of the same type representing a portion of this Iterable from start up to but not including end.
`_____(begin?: number, end?: number): Iterable`
*11 creating subsets methods.*
slice
Returns a new Iterable of the same type representing a portion of this Iterable from start up to but not including end.
`slice(begin?: number, end?: number): Iterable`
133
Iterable
Returns a new Iterable of the same type containing all entries except the first.
`_____(): Iterable`
*11 creating subsets methods.*
rest
Returns a new Iterable of the same type containing all entries except the first.
`rest(): Iterable`
134
Iterable
Returns a new Iterable of the same type containing all entries except the last.
`_____(): Iterable`
*11 creating subsets methods.*
butLast
Returns a new Iterable of the same type containing all entries except the last.
`butLast(): Iterable`
135
Iterable
Returns a new Iterable of the same type which excludes the first `amount` entries from this Iterable.
`_____(amount: number): Iterable`
*11 creating subsets methods.*
skip
Returns a new Iterable of the same type which excludes the first `amount` entries from this Iterable.
`skip(amount: number): Iterable`
136
Iterable
Returns a new Iterable of the same type which excludes the last `amount` entries from this Iterable.
`_____(amount: number): Iterable`
*11 creating subsets methods.*
skipLast
Returns a new Iterable of the same type which excludes the last `amount` entries from this Iterable.
`skipLast(amount: number): Iterable`
137
Iterable
Returns a new Iterable of the same type which includes entries starting from when `predicate` first returns false.
`_____(
predicate: (value?: V, key?: K, iter?: Iterable) => boolean,context?: any
): Iterable`
*11 creating subsets methods.*
skipWhile
Returns a new Iterable of the same type which includes entries starting from when `predicate` first returns false.
`skipWhile(
predicate: (value?: V, key?: K, iter?: Iterable) => boolean,context?: any
): Iterable`
138
Iterable
Returns a new Iterable of the same type which includes entries starting from when `predicate` first returns true.
`_____(
predicate: (value?: V, key?: K, iter?: Iterable) => boolean,context?: any
): Iterable`
*11 creating subsets methods.*
skipUntil
Returns a new Iterable of the same type which includes entries starting from when `predicate` first returns true.
`skipUntil(
predicate: (value?: V, key?: K, iter?: Iterable) => boolean,context?: any
): Iterable`
139
Iterable
Returns a new Iterable of the same type which includes the first `amount` entries from this Iterable.
`_____(amount: number): Iterable`
*11 creating subsets methods.*
take
Returns a new Iterable of the same type which includes the first `amount` entries from this Iterable.
`take(amount: number): Iterable`
140
Iterable
Returns a new Iterable of the same type which includes the last `amount` entries from this Iterable.
`_____(amount: number): Iterable`
*11 creating subsets methods.*
takeLast
Returns a new Iterable of the same type which includes the last `amount` entries from this Iterable.
`takeLast(amount: number): Iterable`
141
Iterable
Returns a new Iterable of the same type which includes entries from this Iterable as long as the `predicate` returns true.
`_____(
predicate: (value?: V, key?: K, iter?: Iterable) => boolean,context?: any
): Iterable`
*11 creating subsets methods.*
takeWhile
Returns a new Iterable of the same type which includes entries from this Iterable as long as the `predicate` returns true.
`takeWhile(
predicate: (value?: V, key?: K, iter?: Iterable) => boolean,context?: any
): Iterable`
142
Iterable
Returns a new Iterable of the same type which includes entries from this Iterable as long as the `predicate` returns false.
`_____(
predicate: (value?: V, key?: K, iter?: Iterable) => boolean,context?: any
): Iterable`
*11 creating subsets methods.*
takeUntil
Returns a new Iterable of the same type which includes entries from this Iterable as long as the `predicate` returns false.
`takeUntil(
predicate: (value?: V, key?: K, iter?: Iterable) => boolean,context?: any
): Iterable`
143
Iterable
Returns a new Iterable of the same type with other values and iterable-like \_\_\_\_\_enated to this one.
`_____(...valuesOrIterables: any[]): Iterable`
*3 combination methods.*
concat
Returns a new Iterable of the same type with other values and iterable-like concatenated to this one.
`concat(...valuesOrIterables: any[]): Iterable`
144
Iterable
Flattens nested Iterables.
`_____(depth?: number): Iterable_____(shallow?: boolean): Iterable`
*3 combination methods.*
flatten
Flattens nested Iterables.
`flatten(depth?: number): Iterableflatten(shallow?: boolean): Iterable`
145
Iterable
Flat-maps the Iterable, returning an Iterable of the same type.
`_____(
mapper: (value?: V, key?: K, iter?: Iterable) => Iterable,context?: any
): Iterable_____(
mapper: (value?: V, key?: K, iter?: Iterable) => any,context?: any
): Iterable`
*3 combination methods.*
flatMap
Flat-maps the Iterable, returning an Iterable of the same type.
`flatMap(
mapper: (value?: V, key?: K, iter?: Iterable) => Iterable,context?: any
): IterableflatMap(
mapper: (value?: V, key?: K, iter?: Iterable) => any,context?: any
): Iterable`
146
Iterable
Reduces the Iterable to a value by calling the `_____r` for every entry in the Iterable and passing along the \_\_\_\_\_d value.
`_____(
_____r: (reduction?: R, value?: V, key?: K, iter?: Iterable) => R,initialReduction?: R,context?: any
): R`
*8 reducing a value methods.*
reduce
Reduces the Iterable to a value by calling the `reducer` for every entry in the Iterable and passing along the reduced value.
`reduce(
reducer: (reduction?: R, value?: V, key?: K, iter?: Iterable) => R,initialReduction?: R,context?: any
): R`
147
Iterable
Reduces the Iterable in reverse (from the right side).
`_____(
reducer: (reduction?: R, value?: V, key?: K, iter?: Iterable) => R,initialReduction?: R,context?: any
): R`
*8 reducing a value methods.*
reduceRight
Reduces the Iterable in reverse (from the right side).
`reduceRight(
reducer: (reduction?: R, value?: V, key?: K, iter?: Iterable) => R,initialReduction?: R,context?: any
): R`
148
Iterable
True if `predicate` returns true for all entries in the Iterable.
`_____(
predicate: (value?: V, key?: K, iter?: Iterable) => boolean,context?: any
): boolean`
*8 reducing a value methods.*
every
True if `predicate` returns true for all entries in the Iterable.
`every(
predicate: (value?: V, key?: K, iter?: Iterable) => boolean,context?: any
): boolean`
149
Iterable
True if `predicate` returns true for any entry in the Iterable.
`_____(
predicate: (value?: V, key?: K, iter?: Iterable) => boolean,context?: any
): boolean`
*8 reducing a value methods.*
some
True if `predicate` returns true for any entry in the Iterable.
`some(
predicate: (value?: V, key?: K, iter?: Iterable) => boolean,context?: any
): boolean`
150
Iterable
Joins values together as a string, inserting a separator between each. The default separator is `","`.
`_____(separator?: string): string`
*8 reducing a value methods.*
join
Joins values together as a string, inserting a separator between each. The default separator is `","`.
`join(separator?: string): string`
151
Iterable
Returns true if this Iterable includes no values.
`_____(): boolean`
*8 reducing a value methods.*
isEmpty
Returns true if this Iterable includes no values.
`isEmpty(): boolean`
152
Iterable
Returns the size of this Iterable.
`_____(): number_____(
predicate: (value?: V, key?: K, iter?: Iterable) => boolean,context?: any
): number`
*8 reducing a value methods.*
count
Returns the size of this Iterable.
`count(): numbercount(
predicate: (value?: V, key?: K, iter?: Iterable) => boolean,context?: any
): number`
153
Iterable
Returns a `KeyedSeq` of counts, grouped by the return value of the `grouper` function.
`_____(
grouper: (value?: V, key?: K, iter?: Iterable) => G,context?: any
): Map`
*8 reducing a value methods.*
countBy
Returns a `KeyedSeq` of counts, grouped by the return value of the `grouper` function.
`countBy(
grouper: (value?: V, key?: K, iter?: Iterable) => G,context?: any
): Map`
154
Iterable
Returns the value for which the `predicate` returns true.
`_____(
predicate: (value?: V, key?: K, iter?: Iterable) => boolean,context?: any,notSetValue?: V
): V`
*8 search for value methods.*
find
Returns the value for which the `predicate` returns true.
`find(
predicate: (value?: V, key?: K, iter?: Iterable) => boolean,context?: any,notSetValue?: V
): V`
155
Iterable
Returns the last value for which the `predicate` returns true.
`_____(
predicate: (value?: V, key?: K, iter?: Iterable) => boolean,context?: any,notSetValue?: V
): V`
*8 search for value methods.*
findLast
Returns the last value for which the `predicate` returns true.
`findLast(
predicate: (value?: V, key?: K, iter?: Iterable) => boolean,context?: any,notSetValue?: V
): V`
156
Iterable
Returns the [key, value] entry for which the `predicate` returns true.
`_____(
predicate: (value?: V, key?: K, iter?: Iterable) => boolean,context?: any,notSetValue?: V
): Array`
*8 search for value methods.*
findEntry
Returns the [key, value] entry for which the `predicate` returns true.
`findEntry(
predicate: (value?: V, key?: K, iter?: Iterable) => boolean,context?: any,notSetValue?: V
): Array`
157
Iterable
Returns the last [key, value] entry for which the `predicate` returns true.
`_____(
predicate: (value?: V, key?: K, iter?: Iterable) => boolean,context?: any,notSetValue?: V
): Array`
*8 search for value methods.*
findLastEntry
Returns the last [key, value] entry for which the `predicate` returns true.
`findLastEntry(
predicate: (value?: V, key?: K, iter?: Iterable) => boolean,context?: any,notSetValue?: V
): Array`
158
Iterable
Returns the \_\_\_\_\_imum value in this collection. If any values are comparatively equivalent, the first one found will be returned.
`_____(comparator?: (valueA: V, valueB: V) => number): V`
*8 search for value methods.*
max
Returns the maximum value in this collection. If any values are comparatively equivalent, the first one found will be returned.
`max(comparator?: (valueA: V, valueB: V) => number): V`
159
Iterable
Like `max`, but also accepts a `comparatorValueMapper` which allows for comparing by more sophisticated means:
`_____(
comparatorValueMapper: (value?: V, key?: K, iter?: Iterable) => C,comparator?: (valueA: C, valueB: C) => number
): V`
*8 search for value methods.*
maxBy
Like `max`, but also accepts a `comparatorValueMapper` which allows for comparing by more sophisticated means:
`maxBy(
comparatorValueMapper: (value?: V, key?: K, iter?: Iterable) => C,comparator?: (valueA: C, valueB: C) => number
): V`
160
Iterable
Returns the \_\_\_\_\_imum value in this collection. If any values are comparatively equivalent, the first one found will be returned.
`_____(comparator?: (valueA: V, valueB: V) => number): V`
*8 search for value methods.*
min
Returns the minimum value in this collection. If any values are comparatively equivalent, the first one found will be returned.
`min(comparator?: (valueA: V, valueB: V) => number): V`
161
Iterable
Like `min`, but also accepts a `comparatorValueMapper` which allows for comparing by more sophisticated means:
`_____(
comparatorValueMapper: (value?: V, key?: K, iter?: Iterable) => C,comparator?: (valueA: C, valueB: C) => number
): V`
*8 search for value methods.*
minBy
Like `min`, but also accepts a `comparatorValueMapper` which allows for comparing by more sophisticated means:
`minBy(
comparatorValueMapper: (value?: V, key?: K, iter?: Iterable) => C,comparator?: (valueA: C, valueB: C) => number
): V`
162
Iterable
True if `iter` includes every value in this Iterable.
`_____(iter: Iterable): boolean_____(iter: Array): boolean`
*2 comparison methods.*
isSubset
True if `iter` includes every value in this Iterable.
`isSubset(iter: Iterable): booleanisSubset(iter: Array): boolean`
163
Iterable
True if this Iterable includes every value in `iter`.
`_____(iter: Iterable): boolean_____(iter: Array): boolean`
*2 comparison methods.*
isSuperset
True if this Iterable includes every value in `iter`.
`isSuperset(iter: Iterable): booleanisSuperset(iter: Array): boolean`
164
KeyedIterable
Creates a \_\_\_\_\_
`_____(iter:_____): __________(iter: Iterable): __________(array: Array): __________(obj: {[key: string]: V}): __________(iterator: Iterator): __________(iterable: Object): _____`
*1 construction methods.*
KeyedIterable
Creates a KeyedIterable
`KeyedIterable(iter: KeyedIterable): KeyedIterableKeyedIterable(iter: Iterable): KeyedIterableKeyedIterable(array: Array): KeyedIterableKeyedIterable(obj: {[key: string]: V}): KeyedIterableKeyedIterable(iterator: Iterator): KeyedIterableKeyedIterable(iterable: Object): KeyedIterable`
165
KeyedIterable
Returns KeyedSeq.
`_____(): KeyedSeq`
*4 conversion to seq methods.*
toSeq
Returns KeyedSeq.
`toSeq(): KeyedSeq`
166
KeyedIterable
Returns a new KeyedIterable of the same type where the keys and values have been \_\_\_\_\_ped.
`_____(): KeyedIterable`
*3 sequence functions methods.*
flip
Returns a new KeyedIterable of the same type where the keys and values have been flipped.
`flip(): KeyedIterable`
167
KeyedIterable
Returns a new KeyedIterable of the same type with keys passed through a `mapper` function.
`_____(
mapper: (key?: K, value?: V, iter?: KeyedIterable) => M,context?: any
): KeyedIterable`
*3 sequence functions methods.*
mapKeys
Returns a new KeyedIterable of the same type with keys passed through a `mapper` function.
`mapKeys(
mapper: (key?: K, value?: V, iter?: KeyedIterable) => M,context?: any
): KeyedIterable`
168
KeyedIterable
Returns a new KeyedIterable of the same type with entries ([key, value] tuples) passed through a `mapper` function.
`_____(
mapper: (
entry?: Array,index?: number,iter?: KeyedIterable
) => Array,context?: any
): KeyedIterable`
*3 sequence functions methods.*
mapEntries
Returns a new KeyedIterable of the same type with entries ([key, value] tuples) passed through a `mapper` function.
`mapEntries(
mapper: (
entry?: Array,index?: number,iter?: KeyedIterable
) => Array,context?: any
): KeyedIterable`
169
KeyedIterable
Returns the key associated with the search value, or undefined.
`_____(searchValue: V): K`
*12 search for value methods.*
keyOf
Returns the key associated with the search value, or undefined.
`keyOf(searchValue: V): K`
170
KeyedIterable
Returns the last key associated with the search value, or undefined.
`_____(searchValue: V): K`
*12 search for value methods.*
lastKeyOf
Returns the last key associated with the search value, or undefined.
`lastKeyOf(searchValue: V): K`
171
KeyedIterable
Returns the key for which the `predicate` returns true.
`_____(
predicate: (value?: V, key?: K, iter?: KeyedIterable) => boolean,context?: any
): K`
*12 search for value methods.*
findKey
Returns the key for which the `predicate` returns true.
`findKey(
predicate: (value?: V, key?: K, iter?: KeyedIterable) => boolean,context?: any
): K`
172
KeyedIterable
Returns the last key for which the `predicate` returns true.
`_____(
predicate: (value?: V, key?: K, iter?: KeyedIterable) => boolean,context?: any
): K`
*12 search for value methods.*
findLastKey
Returns the last key for which the `predicate` returns true.
`findLastKey(
predicate: (value?: V, key?: K, iter?: KeyedIterable) => boolean,context?: any
): K`
173
IndexedIterable
Creates a new \_\_\_\_\_.
`_____(iter:_____): __________(iter: SetIterable): __________(iter: KeyedIterable): __________(array: Array): __________(iterator: Iterator): __________(iterable: Object): _____`
*1 construction methods.*
IndexedIterable
Creates a new IndexedIterable.
`IndexedIterable(iter: IndexedIterable): IndexedIterableIndexedIterable(iter: SetIterable): IndexedIterableIndexedIterable(iter: KeyedIterable): IndexedIterableIndexedIterable(array: Array): IndexedIterableIndexedIterable(iterator: Iterator): IndexedIterableIndexedIterable(iterable: Object): IndexedIterable`
174
IndexedIterable
Returns the value associated with the provided index, or notSetValue if the index is beyond the bounds of the Iterable.
`_____(index: number, notSetValue?: T): T`
*5 reading values methods.*
get
Returns the value associated with the provided index, or notSetValue if the index is beyond the bounds of the Iterable.
`get(index: number, notSetValue?: T): T`
175
IndexedIterable
Returns IndexedSeq.
`_____(): IndexedSeq`
*5 conversion to seq methods.*
toSeq
Returns IndexedSeq.
`toSeq(): IndexedSeq`
176
IndexedIterable
If this is an iterable of [key, value] entry tuples, it will return a KeyedSeq of those entries.
`_____(): KeyedSeq`
*5 conversion to seq methods.*
fromEntrySeq
If this is an iterable of [key, value] entry tuples, it will return a KeyedSeq of those entries.
`fromEntrySeq(): KeyedSeq`
177
IndexedIterable
Returns an Iterable of the same type with `separator` between each item in this Iterable.
`_____(separator: T): IndexedIterable`
*8 combination methods.*
interpose
Returns an Iterable of the same type with `separator` between each item in this Iterable.
`interpose(separator: T): IndexedIterable`
178
IndexedIterable
Returns an Iterable of the same type with the provided `iterables` \_\_\_\_\_d into this iterable.
`_____(...iterables: Array>): IndexedIterable`
*8 combination methods.*
interleave
Returns an Iterable of the same type with the provided `iterables` interleaved into this iterable.
`interleave(...iterables: Array>): IndexedIterable`
179
IndexedIterable
Splice returns a new indexed Iterable by replacing a region of this Iterable with new values. If values are not provided, it only skips the region to be removed.
`_____(index: number, removeNum: number, ...values: any[]): IndexedIterable`
*8 combination methods.*
splice
Splice returns a new indexed Iterable by replacing a region of this Iterable with new values. If values are not provided, it only skips the region to be removed.
`splice(index: number, removeNum: number, ...values: any[]): IndexedIterable`
180
IndexedIterable
Returns an Iterable of the same type "\_\_\_\_\_ped" with the provided iterables.
`_____(...iterables: Array>): IndexedIterable`
*8 combination methods.*
zip
Returns an Iterable of the same type "zipped" with the provided iterables.
`zip(...iterables: Array>): IndexedIterable`
181
IndexedIterable
Returns an Iterable of the same type "zipped" with the provided iterables by using a custom `zipper` function.
`_____(
zipper: (value: T, otherValue: U) => Z,otherIterable: Iterable
): IndexedIterable_____(
zipper: (value: T, otherValue: U, thirdValue: V) => Z,otherIterable: Iterable,thirdIterable: Iterable
): IndexedIterable_____(
zipper: (...any: Array) => Z,...iterables: Array>
): IndexedIterable`
*8 combination methods.*
zipWith
Returns an Iterable of the same type "zipped" with the provided iterables by using a custom `zipper` function.
`zipWith(
zipper: (value: T, otherValue: U) => Z,otherIterable: Iterable
): IndexedIterablezipWith(
zipper: (value: T, otherValue: U, thirdValue: V) => Z,otherIterable: Iterable,thirdIterable: Iterable
): IndexedIterablezipWith(
zipper: (...any: Array) => Z,...iterables: Array>
): IndexedIterable`
182
IndexedIterable
Returns the first index at which a given value can be found in the Iterable, or -1 if it is not present.
`_____(searchValue: T): number`
*12 search for value methods.*
indexOf
Returns the first index at which a given value can be found in the Iterable, or -1 if it is not present.
`indexOf(searchValue: T): number`
183
IndexedIterable
Returns the last index at which a given value can be found in the Iterable, or -1 if it is not present.
`_____(searchValue: T): number`
*12 search for value methods.*
lastIndexOf
Returns the last index at which a given value can be found in the Iterable, or -1 if it is not present.
`lastIndexOf(searchValue: T): number`
184
IndexedIterable
Returns the first index in the Iterable where a value satisfies the provided predicate function. Otherwise -1 is returned.
`_____(
predicate: (value?: T, index?: number, iter?: IndexedIterable) => boolean,context?: any
): number`
*12 search for value methods.*
findIndex
Returns the first index in the Iterable where a value satisfies the provided predicate function. Otherwise -1 is returned.
`findIndex(
predicate: (value?: T, index?: number, iter?: IndexedIterable) => boolean,context?: any
): number`
185
IndexedIterable
Returns the last index in the Iterable where a value satisfies the provided predicate function. Otherwise -1 is returned.
`_____(
predicate: (value?: T, index?: number, iter?: IndexedIterable) => boolean,context?: any
): number`
*12 search for value methods.*
findLastIndex
Returns the last index in the Iterable where a value satisfies the provided predicate function. Otherwise -1 is returned.
`findLastIndex(
predicate: (value?: T, index?: number, iter?: IndexedIterable) => boolean,context?: any
): number`
186
SetIterable
Similar to `Iterable()`, but always returns a \_\_\_\_\_.
`_____(iter:_____): __________(iter: IndexedIterable): __________(iter: KeyedIterable): __________(array: Array): __________(iterator: Iterator): __________(iterable: Object): _____`
*1 construction methods.*
SetIterable
Similar to `Iterable()`, but always returns a SetIterable.
`SetIterable(iter: SetIterable): SetIterableSetIterable(iter: IndexedIterable): SetIterableSetIterable(iter: KeyedIterable): SetIterableSetIterable(array: Array): SetIterableSetIterable(iterator: Iterator): SetIterableSetIterable(iterable: Object): SetIterable`
187
SetIterable
Returns SetSeq.
`_____(): SetSeq`
*4 conversion to seq methods.*
toSeq
Returns SetSeq.
`toSeq(): SetSeq`
188
Collection
`_____ze: number`
*1 members methods.*
si
`size: number`
189
KeyedCollection
Returns KeyedSeq.
`_____(): KeyedSeq`
*4 conversion to seq methods.*
toSeq
Returns KeyedSeq.
`toSeq(): KeyedSeq`
190
IndexedCollection
Returns IndexedSeq.
`_____(): IndexedSeq`
*5 conversion to seq methods.*
toSeq
Returns IndexedSeq.
`toSeq(): IndexedSeq`
191
SetCollection
Returns SetSeq.
`_____(): SetSeq`
*4 conversion to seq methods.*
toSeq
Returns SetSeq.
`toSeq(): SetSeq`
