文档建议反馈控制台
首页
学习
活动
专区
工具
TVP
最新优惠活动
文章/答案/技术大牛
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

List

列表是有序索引的密集集合，很像JavaScript数组。

代码语言：javascript
复制
class List<T> extends Collection.Indexed<T>

Discussion

列表是不可变的，并且完全持久化，O（log32 N）获取和设置，以及O（1）推送和弹出。

列出实现Deque，并从end（push，pop）和beginning（unshift，shift）中有效地添加和删除。

与JavaScript数组不同，“未设置”索引与设置为的索引之间没有区别undefined。List#forEach不管它们是否被明确定义，都会访问从0到大小的所有索引。

Construction

List()

创建一个包含所提供的iterable-like的值的新的不可变列表。

代码语言：javascript
复制
List<T>(): List<T>
List<T>(iter: Iterable.Indexed<T>): List<T>
List<T>(iter: Iterable.Set<T>): List<T>
List<K, V>(iter: Iterable.Keyed<K, V>): List<any>
List<T>(array: Array<T>): List<T>
List<T>(iterator: Iterator<T>): List<T>
List<T>(iterable: Object): List<T>

Static methods

List.isList()

如果提供的值是List，则为true

代码语言：javascript
复制
List.isList(maybeList: any): boolean

List.of()

创建一个包含的新列表values。

代码语言：javascript
复制
List.of<T>(...values: T[]): List<T>

Members

List#size

代码语言：javascript
复制
size: number

Inherited from

Collection#size

Persistent changes

List#set()

返回包含value 的新列表index。如果index已经存在于此列表中，它将被替换。

代码语言：javascript
复制
set(index: number, value: T): List<T>

Discussion

index可能是一个负数，从列表末尾开始索引。v.set(-1, "value")设置列表中的最后一个项目。

如果index大于size，返回的List size将会足够大以包含index。

List#delete()

返回一个新的列表，它排除了这个index，并且大小小于这个列表。上述指数的值index向下移动1以填补位置。

代码语言：javascript
复制
delete(index: number): List<T>

alias

remove()

Discussion

这是同义词list.splice(index, 1)。

index可能是一个负数，从列表末尾开始索引。v.delete(-1)删除列表中的最后一个项目。

注意：delete不能在IE8中安全使用

List#insert()

返回带有valueat 的新列表，index其大小为1，大于此列表。上述指数的值index移动了1。

代码语言：javascript
复制
insert(index: number, value: T): List<T>

Discussion

这与`list.splice(index,0,value)是同义词，

List#clear()

返回一个具有0大小且没有值的新列表。

代码语言：javascript
复制
clear(): List<T>

List#push()

从列表中返回一个新的列表，并values附带提供的size。

代码语言：javascript
复制
push(...values: T[]): List<T>

List#pop()

返回一个新列表，其大小小于此列表，不包括此列表中的最后一个索引。

代码语言：javascript
复制
pop(): List<T>

Discussion

注意：这不同于Array#pop因为它返回一个新的列表而不是删除的值。使用last()获得此列表中最后一个值。

List#unshift()

返回一个新的列表，并提供values预先提供的值，将其他值前移到较高的索引处。

代码语言：javascript
复制
unshift(...values: T[]): List<T>

List#shift()

返回一个新列表，其大小小于此列表，不包括此列表中的第一个索引，将所有其他值移至较低索引。

代码语言：javascript
复制
shift(): List<T>

Discussion

注意：这不同于Array#shift因为它返回一个新的列表而不是删除的值。使用first()获得此列表中第一个值。

List#update()

返回一个新的List，其中更新值为index，返回值是调用updater现有值，或者notSetValue是否index未设置。如果使用单个参数调用，updater则使用List自身调用。

代码语言：javascript
复制
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>

see

Map#update

Discussion

index可能是一个负数，从列表末尾开始索引。v.update(-1)更新列表中的最后一个项目。

List#merge()

代码语言：javascript
复制
merge(...iterables: Iterable.Indexed<T>[]): List<T>
merge(...iterables: Array<T>[]): List<T>

see

Map#merge

List#mergeWith()

代码语言：javascript
复制
mergeWith(merger: (previous?: T, next?: T, key?: number) => T,...iterables: Iterable.Indexed<T>[]): List<T>
mergeWith(merger: (previous?: T, next?: T, key?: number) => T,...iterables: Array<T>[]): List<T>

see

Map#mergeWith

List#mergeDeep()

代码语言：javascript
复制
mergeDeep(...iterables: Iterable.Indexed<T>[]): List<T>
mergeDeep(...iterables: Array<T>[]): List<T>

see

Map#mergeDeep

List#mergeDeepWith()

代码语言：javascript
复制
mergeDeepWith(merger: (previous?: T, next?: T, key?: number) => T,...iterables: Iterable.Indexed<T>[]): List<T>
mergeDeepWith(merger: (previous?: T, next?: T, key?: number) => T,...iterables: Array<T>[]): List<T>

see

Map#mergeDeepWith

List#setSize()

返回一个带有大小的新列表size。如果size小于此列表的大小，则新列表将排除较高索引处的值。如果size大于此列表的大小，新列表将为新近可用的索引定义未定义的值。

代码语言：javascript
复制
setSize(size: number): List<T>

Discussion

当建立一个新的列表并且最终大小被预先知道时，setSize与其一起使用withMutations可能导致更高性能的构造。

Deep persistent changes

List#setIn()

返回已经树立了新的列表value在此keyPath。如果任何键keyPath不存在，将在该键上创建一个新的不可变Map。

代码语言：javascript
复制
setIn(keyPath: Array<any>, value: any): List<T>
setIn(keyPath: Iterable<any, any>, value: any): List<T>

Discussion

索引号被用作关键字来确定列表中的路径。

List#deleteIn()

返回已删除此值的新列表keyPath。如果任何键keyPath不存在，则不会发生变化。

代码语言：javascript
复制
deleteIn(keyPath: Array<any>): List<T>
deleteIn(keyPath: Iterable<any, any>): List<T>

alias

removeIn()

List#updateIn()

代码语言：javascript
复制
updateIn(keyPath: Array<any>, updater: (value: any) => any): List<T>
updateIn(keyPath: Array<any>,notSetValue: any,updater: (value: any) => 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): List<T>

see

Map#updateIn

List#mergeIn()

代码语言：javascript
复制
mergeIn(keyPath: Iterable<any, any>,...iterables: Iterable.Indexed<T>[]): List<T>
mergeIn(keyPath: Array<any>, ...iterables: Iterable.Indexed<T>[]): List<T>
mergeIn(keyPath: Array<any>, ...iterables: Array<T>[]): List<T>

see

Map#mergeIn

List#mergeDeepIn()

代码语言：javascript
复制
mergeDeepIn(keyPath: Iterable<any, any>,...iterables: Iterable.Indexed<T>[]): List<T>
mergeDeepIn(keyPath: Array<any>, ...iterables: Iterable.Indexed<T>[]): List<T>
mergeDeepIn(keyPath: Array<any>, ...iterables: Array<T>[]): List<T>

see

Map#mergeDeepIn

Transient changes

List#withMutations()

注意：并非所有方法都可用于可变集合或内部withMutations！只有set，push，pop，shift，unshift和merge可变化的使用。

代码语言：javascript
复制
withMutations(mutator: (mutable: List<T>) => any): List<T>

see

Map#withMutations

List#asMutable()

代码语言：javascript
复制
asMutable(): List<T>

see

Map#asMutable

List#asImmutable()

代码语言：javascript
复制
asImmutable(): List<T>

see

Map#asImmutable

Conversion to Seq

List#toSeq()

返回Seq.Indexed。

代码语言：javascript
复制
toSeq(): Seq.Indexed<T>

Inherited from

Collection.Indexed#toSeq

List#toKeyedSeq()

从此Iterable返回一个Seq.Keyed，其索引被视为键。

代码语言：javascript
复制
toKeyedSeq(): Seq.Keyed<number, T>

Inherited from

Iterable#toKeyedSeq

Discussion

如果您想要对Iterable.Indexed进行操作并保留索引那么这非常有用。

返回的Seq将具有与此Iterable相同的迭代顺序。

Example:

代码语言：javascript
复制
var indexedSeq = Immutable.Seq.of('A', 'B', 'C');
indexedSeq.filter(v => v === 'B').toString() // Seq [ 'B' ]
var keyedSeq = indexedSeq.toKeyedSeq();
keyedSeq.filter(v => v === 'B').toString() // Seq { 1: 'B' }

List#toIndexedSeq()

返回一个Seq.Indexed这个Iterable的值，这是丢弃键。

代码语言：javascript
复制
toIndexedSeq(): Seq.Indexed<T>

Inherited from

Iterable#toIndexedSeq

List#toSetSeq()

返回一个Seq.Set这个Iterable的值，这是丢弃键。

代码语言：javascript
复制
toSetSeq(): Seq.Set<T>

Inherited from

Iterable#toSetSeq

List#fromEntrySeq()

如果这是一个可迭代的键值元组，它将返回这些条目的Seq.Keyed。

代码语言：javascript
复制
fromEntrySeq(): Seq.Keyed<any, any>

Inherited from

Iterable.Indexed#fromEntrySeq

Value equality

List#equals()

如果这和另一个Iterable具有值相等性，则为真，如下定义Immutable.is()。

代码语言：javascript
复制
equals(other: Iterable<number, T>): boolean

Inherited from

Iterable#equals

Discussion

注意：这相当于Immutable.is(this, other)，但提供允许链式表达式。

List#hashCode()

计算并返回此Iterable的散列标识。

代码语言：javascript
复制
hashCode(): number

Inherited from

Iterable#hashCode

Discussion

在hashCode一个可迭代的用于确定潜在平等，和添加这一个当使用Set或作为一个键Map，经由不同的实例实现查找。

代码语言：javascript
复制
var a = List.of(1, 2, 3);
var b = List.of(1, 2, 3);
assert(a !== b); // different instances
var set = Set.of(a);
assert(set.has(b) === true);

如果两个值相同hashCode，则不能保证相等（http://en.wikipedia.org/wiki/Collision_（computer_science％29）。如果两个值有不同的hashCodes，则它们不能相等。

Reading values

List#get()

返回与提供的键相关联的值，如果Iterable不包含此键，则返回notSetValue。

代码语言：javascript
复制
get(key: number, notSetValue?: T): T

Inherited from

Iterable#get

Discussion

注意：一个键可能与一个undefined值相关联，所以如果notSetValue没有提供并且该方法返回undefined，那么不能保证没有找到该键。

List#has()

如果此关键字存在Iterable，则为真，Immutable.is用于确定相等性

代码语言：javascript
复制
has(key: number): boolean

Inherited from

Iterable#has

List#includes()

如果此值中存在值Iterable则为true ，Immutable.is用于确定相等性

代码语言：javascript
复制
includes(value: T): boolean

Inherited from

Iterable#includes

alias

contains()

List#first()

Iterable中的第一个值。

代码语言：javascript
复制
first(): T

Inherited from

Iterable#first

List#last()

Iterable中的最后一个值。

代码语言：javascript
复制
last(): T

Inherited from

Iterable#last

Reading deep values

List#getIn()

通过嵌套的Iterables返回键或索引路径的值。

代码语言：javascript
复制
getIn(searchKeyPath: Array<any>, notSetValue?: any): any
getIn(searchKeyPath: Iterable<any, any>, notSetValue?: any): any

Inherited from

Iterable#getIn

List#hasIn()

如果通过嵌套的Iterables跟随键或索引路径的结果导致设置值，则返回true。

代码语言：javascript
复制
hasIn(searchKeyPath: Array<any>): boolean
hasIn(searchKeyPath: Iterable<any, any>): boolean

Inherited from

Iterable#hasIn

Conversion to JavaScript types

List#toJS()

将此Iterable深度转换为等效的JS。

代码语言：javascript
复制
toJS(): any

Inherited from

Iterable#toJS

alias

toJSON()

Discussion

Iterable.Indexeds，Iterable.Sets成为阵列，同时Iterable.Keyeds成为物体。

List#toArray()

浅显地将这个迭代器转换为一个Array，这是丢弃键。

代码语言：javascript
复制
toArray(): Array<T>

Inherited from

Iterable#toArray

List#toObject()

将此Iterable浅转换为一个Object。

代码语言：javascript
复制
toObject(): {[key: string]: V}

Inherited from

Iterable#toObject

Discussion

如果键不是字符串，则抛出。

Conversion to Collections

List#toMap()

将此Iterable转换为Map，如果键不可哈希则抛出。

代码语言：javascript
复制
toMap(): Map<number, T>

Inherited from

Iterable#toMap

Discussion

注意：这相当于Map(this.toKeyedSeq())，但为方便起见并允许链接表达式。

List#toOrderedMap()

将此Iterable转换为Map，并保持迭代顺序。

代码语言：javascript
复制
toOrderedMap(): OrderedMap<number, T>

Inherited from

Iterable#toOrderedMap

Discussion

注意：这相当于OrderedMap(this.toKeyedSeq())，但为方便起见并允许链接表达式。

List#toSet()

将此Iterable转换为Set，放弃键。如果值不可哈希则抛出。

代码语言：javascript
复制
toSet(): Set<T>

Inherited from

Iterable#toSet

Discussion

注意：这相当于Set(this)，但提供允许链式表达式。

List#toOrderedSet()

将此Iterable转换为Set，保持迭代顺序并丢弃键。

代码语言：javascript
复制
toOrderedSet(): OrderedSet<T>

Inherited from

Iterable#toOrderedSet

Discussion

注意：这相当于OrderedSet(this.valueSeq())，但为方便起见并允许链接表达式。

List#toList()

将此Iterable转换为List，放弃键。

代码语言：javascript
复制
toList(): List<T>

Inherited from

Iterable#toList

Discussion

注意：这相当于List(this)，但提供允许链式表达式。

List#toStack()

将此Iterable转换为堆栈，丢弃键。如果值不可哈希则抛出。

代码语言：javascript
复制
toStack(): Stack<T>

Inherited from

Iterable#toStack

Discussion

注意：这相当于Stack(this)，但提供允许链式表达式。

Iterators

List#keys()

这个Iterable键的迭代器。

代码语言：javascript
复制
keys(): Iterator<number>

Inherited from

Iterable#keys

Discussion

注意：这将返回一个不支持Immutable JS序列算法的ES6迭代器。使用keySeq替代，如果这是你想要的。

List#values()

这个Iterable值的迭代器。

代码语言：javascript
复制
values(): Iterator<T>

Inherited from

Iterable#values

Discussion

注意：这将返回一个不支持Immutable JS序列算法的ES6迭代器。使用valueSeq替代，如果这是你想要的。

List#entries()

这个Iterable条目的迭代器作为[key, value]元组。

代码语言：javascript
复制
entries(): Iterator<Array<any>>

Inherited from

Iterable#entries

Discussion

注意：这将返回一个不支持Immutable JS序列算法的ES6迭代器。使用entrySeq替代，如果这是你想要的。

Iterables (Seq)

List#keySeq()

返回此Iterable的新键的Seq.Indexed，放弃值。

代码语言：javascript
复制
keySeq(): Seq.Indexed<number>

Inherited from

Iterable#keySeq

List#valueSeq()

返回一个Seq.Indexed这个Iterable的值，丢弃键。

代码语言：javascript
复制
valueSeq(): Seq.Indexed<T>

Inherited from

Iterable#valueSeq

List#entrySeq()

返回一个新的Seq.Indexed键值值元组。

代码语言：javascript
复制
entrySeq(): Seq.Indexed<Array<any>>

Inherited from

Iterable#entrySeq

Sequence algorithms

List#map()

使用通过mapper函数传递的值返回相同类型的新Iterable 。

代码语言：javascript
复制
map<M>(mapper: (value?: T, key?: number, iter?: Iterable<number, T>) => M,context?: any): Iterable<number, M>

Inherited from

Iterable#map

Example

代码语言：javascript
复制
Seq({ a: 1, b: 2 }).map(x => 10 * x)
// Seq { a: 10, b: 20 }

List#filter()

仅predicate返回函数返回true 的条目返回相同类型的新Iterable 。

代码语言：javascript
复制
filter(predicate: (value?: T, key?: number, iter?: Iterable<number, T>) => boolean,context?: any): Iterable<number, T>

Inherited from

Iterable#filter

Example

代码语言：javascript
复制
Seq({a:1,b:2,c:3,d:4}).filter(x => x % 2 === 0)
// Seq { b: 2, d: 4 }

List#filterNot()

仅predicate返回函数返回false 的条目返回相同类型的新Iterable 。

代码语言：javascript
复制
filterNot(predicate: (value?: T, key?: number, iter?: Iterable<number, T>) => boolean,context?: any): Iterable<number, T>

Inherited from

Iterable#filterNot

Example

代码语言：javascript
复制
Seq({a:1,b:2,c:3,d:4}).filterNot(x => x % 2 === 0)
// Seq { a: 1, c: 3 }

List#reverse()

按相反顺序返回相同类型的新Iterable。

代码语言：javascript
复制
reverse(): Iterable<number, T>

Inherited from

Iterable#reverse

List#sort()

返回包含相同条目的相同类型的新Iterable，通过使用a进行稳定排序comparator。

代码语言：javascript
复制
sort(comparator?: (valueA: T, valueB: T) => number): Iterable<number, T>

Inherited from

Iterable#sort

Discussion

如果comparator没有提供默认比较器使用< and >。

comparator(valueA, valueB):

  • 返回0元素不应该交换的情况。
  • 返回-1（或任何负数）如果valueA之前valueB
  • 返回1（或任何正数）如果valueA后来valueB
  • 它是纯粹的， i.e.即它必须始终为同一对值返回相同的值。

排序没有定义顺序的集合时，它们的顺序等价物将被返回。例如map.sort()返回OrderedMap。

List#sortBy()

就像sort，但也接受一个comparatorValueMapper允许更复杂的手段进行排序的一个方法：

代码语言：javascript
复制
sortBy<C>(comparatorValueMapper: (value?: T,key?: number,iter?: Iterable<number, T>) => C,comparator?: (valueA: C, valueB: C) => number): Iterable<number, T>

Inherited from

Iterable#sortBy

Example

代码语言：javascript
复制
hitters.sortBy(hitter => hitter.avgHits);

List#groupBy()

返回Iterable.Keyed的Iterable.Keyeds，由返回值分组grouper功能。

代码语言：javascript
复制
groupBy<G>(grouper: (value?: T, key?: number, iter?: Iterable<number, T>) => G,context?: any): Seq.Keyed<G, Iterable<number, T>>

Inherited from

Iterable#groupBy

Discussion

注意：这总是一个急切的操作。

Side effects

List#forEach()

该sideEffect是在可迭代的每个条目执行。

代码语言：javascript
复制
forEach(sideEffect: (value?: T, key?: number, iter?: Iterable<number, T>) => any,context?: any): number

Inherited from

Iterable#forEach

Discussion

不同的是Array#forEach，如果有任何sideEffect回报的话false，迭代将停止。返回迭代的条目数（包括返回false的最后一次迭代）。

Creating subsets

List#slice()

返回一个新的Iterable，其类型代表这个Iterable从开始到结束的一部分。

代码语言：javascript
复制
slice(begin?: number, end?: number): Iterable<number, T>

Inherited from

Iterable#slice

Discussion

如果begin是负数，它将从Iterable的末尾偏移。例如slice(-2)返回最后两个条目的Iterable。如果没有提供，则新的Iterable将在此Iterable开始时开始。

如果end是负数，它将从Iterable的末尾偏移。例如slice(0, -1)返回除最后一项之外的所有内容的Iterable。如果没有提供，那么新的Iterable将会持续到这个Iterable的结尾。

如果所请求的分片等同于当前的Iterable，那么它将自行返回。

List#rest()

返回包含除第一个以外的所有条目的同一类型的新Iterable。

代码语言：javascript
复制
rest(): Iterable<number, T>

Inherited from

Iterable#rest

List#butLast()

返回包含除最后一个以外的所有条目的同一类型的新Iterable。

代码语言：javascript
复制
butLast(): Iterable<number, T>

Inherited from

Iterable#butLast

List#skip()

返回amount从此Iterable中排除第一个条目的同一类型的新Iterable。

代码语言：javascript
复制
skip(amount: number): Iterable<number, T>

Inherited from

Iterable#skip

List#skipLast()

返回amount从此Iterable中排除最后一个条目的同一类型的新Iterable。

代码语言：javascript
复制
skipLast(amount: number): Iterable<number, T>

Inherited from

Iterable#skipLast

List#skipWhile()

返回包含从predicate第一个返回false 时开始的相同类型的新Iterable 。

代码语言：javascript
复制
skipWhile(predicate: (value?: T, key?: number, iter?: Iterable<number, T>) => boolean,context?: any): Iterable<number, T>

Inherited from

Iterable#skipWhile

Example

代码语言：javascript
复制
Seq.of('dog','frog','cat','hat','god')
  .skipWhile(x => x.match(/g/))
// Seq [ 'cat', 'hat', 'god' ]

List#skipUntil()

返回包含从predicate第一个返回true 时开始的相同类型的新Iterable 。

代码语言：javascript
复制
skipUntil(predicate: (value?: T, key?: number, iter?: Iterable<number, T>) => boolean,context?: any): Iterable<number, T>

Inherited from

Iterable#skipUntil

Example

代码语言：javascript
复制
Seq.of('dog','frog','cat','hat','god')
  .skipUntil(x => x.match(/hat/))
// Seq [ 'hat', 'god' ]

List#take()

返回包含amount此Iterable中第一个条目的相同类型的新Iterable。

代码语言：javascript
复制
take(amount: number): Iterable<number, T>

Inherited from

Iterable#take

List#takeLast()

返回包含amount此Iterable中最后一个条目的相同类型的新Iterable。

代码语言：javascript
复制
takeLast(amount: number): Iterable<number, T>

Inherited from

Iterable#takeLast

List#takeWhile()

返回包含来自此Iterable的条目的相同类型的新Iterable，只要predicate返回值为true即可。

代码语言：javascript
复制
takeWhile(predicate: (value?: T, key?: number, iter?: Iterable<number, T>) => boolean,context?: any): Iterable<number, T>

Inherited from

Iterable#takeWhile

Example

代码语言：javascript
复制
Seq.of('dog','frog','cat','hat','god')
  .takeWhile(x => x.match(/o/))
// Seq [ 'dog', 'frog' ]

List#takeUntil()

返回包含来自此Iterable的条目的相同类型的新Iterable，只要predicate返回false即可。

代码语言：javascript
复制
takeUntil(predicate: (value?: T, key?: number, iter?: Iterable<number, T>) => boolean,context?: any): Iterable<number, T>

Inherited from

Iterable#takeUntil

Example

代码语言：javascript
复制
Seq.of('dog','frog','cat','hat','god').takeUntil(x => x.match(/at/))
// ['dog', 'frog']

Combination

List#concat()

用其他值返回一个具有相同类型的新Iterable，并将其连接到此类。

代码语言：javascript
复制
concat(...valuesOrIterables: any[]): Iterable<number, T>

Inherited from

Iterable#concat

Discussion

对于Seqs，即使它们具有相同的密钥，所有条目也会出现在所得到的迭代中。

List#flatten()

压扁嵌套的Iterables。

代码语言：javascript
复制
flatten(depth?: number): Iterable<any, any>
flatten(shallow?: boolean): Iterable<any, any>

Inherited from

Iterable#flatten

Discussion

默认情况下会严格地将Iterable扁平化，返回一个相同类型的Iterable，但depth可以以数字或布尔值的形式提供（其中true表示浅层扁平化）。深度为0（或者显示：假）将会变得很平坦。

仅将其他的Iterable变为Flattens，而不是阵列或对象。

注意：flatten(true)在Iterable>上运行并返回Iterable

List#flatMap()

平面映射Iterable，返回相同类型的Iterable。

代码语言：javascript
复制
flatMap<MK, MV>(mapper: (value?: T,key?: number,iter?: Iterable<number, T>) => Iterable<MK, MV>,context?: any): Iterable<MK, MV>
flatMap<MK, MV>(mapper: (value?: T, key?: number, iter?: Iterable<number, T>) => any,context?: any): Iterable<MK, MV>

Inherited from

Iterable#flatMap

Discussion

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

List#interpose()

返回此Iterable中separator每个项目之间的相同类型的Iterable。

代码语言：javascript
复制
interpose(separator: T): Iterable.Indexed<T>

Inherited from

Iterable.Indexed#interpose

List#interleave()

使用提供的iterables交错迭代到此迭代中，返回相同类型的Iterable 。

代码语言：javascript
复制
interleave(...iterables: Array<Iterable<any, T>>): Iterable.Indexed<T>

Inherited from

Iterable.Indexed#interleave

Discussion

由此产生的Iterable包含每个的第一个项目，然后是每个项目的第二个项目等。

代码语言：javascript
复制
I.Seq.of(1,2,3).interleave(I.Seq.of('A','B','C'))
// Seq [ 1, 'A', 2, 'B', 3, 'C' ]

最短的Iterable停止交错。

代码语言：javascript
复制
I.Seq.of(1,2,3).interleave(
  I.Seq.of('A','B'),
  I.Seq.of('X','Y','Z')
)
// Seq [ 1, 'A', 'X', 2, 'B', 'Y' ]

List#splice()

Splice通过用新值替换此Iterable的区域来返回新的索引Iterable。如果未提供值，则只跳过要删除的区域。

代码语言：javascript
复制
splice(index: number, removeNum: number, ...values: any[]): Iterable.Indexed<T>

Inherited from

Iterable.Indexed#splice

Discussion

index可能是一个负数，从Iterable的末尾开始索引。s.splice(-2)在倒数第二项之后拼接。

代码语言：javascript
复制
Seq(['a','b','c','d']).splice(1, 2, 'q', 'r', 's')
// Seq ['a', 'q', 'r', 's', 'd']

List#zip()

使用提供的迭代器返回“压缩”相同类型的Iterable。

代码语言：javascript
复制
zip(...iterables: Array<Iterable<any, any>>): Iterable.Indexed<any>

Inherited from

Iterable.Indexed#zip

Discussion

喜欢zipWith，但使用默认值zipper：创建一个Array。

代码语言：javascript
复制
var a = Seq.of(1, 2, 3);
var b = Seq.of(4, 5, 6);
var c = a.zip(b); // Seq [ [ 1, 4 ], [ 2, 5 ], [ 3, 6 ] ]

List#zipWith()

使用自定义zipper函数返回与提供的迭代“压缩”相同类型的Iterable 。

代码语言：javascript
复制
zipWith<U, Z>(zipper: (value: T, otherValue: U) => Z,otherIterable: Iterable<any, U>): Iterable.Indexed<Z>
zipWith<U, V, Z>(zipper: (value: T, otherValue: U, thirdValue: V) => Z,otherIterable: Iterable<any, U>,thirdIterable: Iterable<any, V>): Iterable.Indexed<Z>
zipWith<Z>(zipper: (...any: Array<any>) => Z,...iterables: Array<Iterable<any, any>>): Iterable.Indexed<Z>

Inherited from

Iterable.Indexed#zipWith

Example

代码语言：javascript
复制
var a = Seq.of(1, 2, 3);
var b = Seq.of(4, 5, 6);
var c = a.zipWith((a, b) => a + b, b); // Seq [ 5, 7, 9 ]

Reducing a value

List#reduce()

通过调用Iterable中的reducer每个条目并传递缩小的值，将Iterable减少为一个值。

代码语言：javascript
复制
reduce<R>(reducer: (reduction?: R,value?: T,key?: number,iter?: Iterable<number, T>) => R,initialReduction?: R,context?: any): R

Inherited from

Iterable#reduce

see

Discussion

如果initialReduction未提供，或者为空，则将使用Iterable中的第一项。

List#reduceRight()

反向（从右侧）减少Iterable。

代码语言：javascript
复制
reduceRight<R>(reducer: (reduction?: R,value?: T,key?: number,iter?: Iterable<number, T>) => R,initialReduction?: R,context?: any): R

Inherited from

Iterable#reduceRight

Discussion

注意：类似于this.reverse()。reduce()，并提供与奇偶校验Array#reduceRight。

List#every()

如果predicate对Iterable中的所有条目返回true，则返回true。

代码语言：javascript
复制
every(predicate: (value?: T, key?: number, iter?: Iterable<number, T>) => boolean,context?: any): boolean

Inherited from

Iterable#every

List#some()

如果predicate对Iterable中的任何条目返回true，则返回true。

代码语言：javascript
复制
some(predicate: (value?: T, key?: number, iter?: Iterable<number, T>) => boolean,context?: any): boolean

Inherited from

Iterable#some

List#join()

将值作为字符串连接在一起，在每个值之间插入一个分隔符。默认分隔符是","。

代码语言：javascript
复制
join(separator?: string): string

Inherited from

Iterable#join

List#isEmpty()

如果此Iterable不包含任何值，则返回true。

代码语言：javascript
复制
isEmpty(): boolean

Inherited from

Iterable#isEmpty

Discussion

对于一些懒惰的人Seq，isEmpty可能需要迭代以确定空虚。至多会发生一次迭代。

List#count()

返回此Iterable的大小。

代码语言：javascript
复制
count(): number
count(predicate: (value?: T, key?: number, iter?: Iterable<number, T>) => boolean,context?: any): number

Inherited from

Iterable#count

Discussion

不管这个Iterable是否可以懒惰地描述它的大小（有些Seqs不能），这个方法总是会返回正确的大小。例如，Seq如果需要，它会评估一个懒惰。

如果predicate提供，则返回Iterable中predicate返回值为true 的条目的计数。

List#countBy()

返回一个Seq.Keyed计数，按grouper函数的返回值分组。

代码语言：javascript
复制
countBy<G>(grouper: (value?: T, key?: number, iter?: Iterable<number, T>) => G,context?: any): Map<G, number>

Inherited from

Iterable#countBy

Discussion

注意：这不是一个懒惰的操作。

Search for value

List#find()

返回predicate返回true 的第一个值。

代码语言：javascript
复制
find(predicate: (value?: T, key?: number, iter?: Iterable<number, T>) => boolean,context?: any,notSetValue?: T): T

Inherited from

Iterable#find

List#findLast()

返回返回值为predicatetrue 的最后一个值。

代码语言：javascript
复制
findLast(predicate: (value?: T, key?: number, iter?: Iterable<number, T>) => boolean,context?: any,notSetValue?: T): T

Inherited from

Iterable#findLast

Discussion

注意：predicate每个条目都会被调用。

List#findEntry()

返回返回值为true的第一个键值对predicate。

代码语言：javascript
复制
findEntry(predicate: (value?: T, key?: number, iter?: Iterable<number, T>) => boolean,context?: any,notSetValue?: T): Array<any>

Inherited from

Iterable#findEntry

List#findLastEntry()

返回返回值为true的最后一个键值对predicate。

代码语言：javascript
复制
findLastEntry(predicate: (value?: T, key?: number, iter?: Iterable<number, T>) => boolean,context?: any,notSetValue?: T): Array<any>

Inherited from

Iterable#findLastEntry

Discussion

注意：predicate每个条目都会被调用。

List#findKey()

返回predicate返回true 的键。

代码语言：javascript
复制
findKey(predicate: (value?: T,key?: number,iter?: Iterable.Keyed<number, T>) => boolean,context?: any): number

Inherited from

Iterable#findKey

List#findLastKey()

返回predicate返回true 的最后一个键。

代码语言：javascript
复制
findLastKey(predicate: (value?: T,key?: number,iter?: Iterable.Keyed<number, T>) => boolean,context?: any): number

Inherited from

Iterable#findLastKey

Discussion

注意：predicate每个条目都会被调用。

List#keyOf()

返回与搜索值关联的键，或者未定义。

代码语言：javascript
复制
keyOf(searchValue: T): number

Inherited from

Iterable#keyOf

List#lastKeyOf()

返回与搜索值关联的最后一个键，或者未定义。

代码语言：javascript
复制
lastKeyOf(searchValue: T): number

Inherited from

Iterable#lastKeyOf

List#max()

返回此集合中的最大值。如果任何值相当相等，则找到的第一个将被返回。

代码语言：javascript
复制
max(comparator?: (valueA: T, valueB: T) => number): T

Inherited from

Iterable#max

Discussion

在comparator以同样的方式使用Iterable#sort。如果未提供，则默认比较器为>。

当两个值被认为是等价的，遇到的第一个将被返回。否则，max只要比较器是可交换的，将独立于输入的顺序进行操作。默认比较器只有在类型不相同时才>可以交换。

如果comparator返回0，且其中任一值为NaN，undefined或null，则将返回该值。

List#maxBy()

喜欢max，但也接受一个comparatorValueMapper允许通过更复杂的手段比较：

代码语言：javascript
复制
maxBy<C>(comparatorValueMapper: (value?: T,key?: number,iter?: Iterable<number, T>) => C,comparator?: (valueA: C, valueB: C) => number): T

Inherited from

Iterable#maxBy

Example

代码语言：javascript
复制
hitters.maxBy(hitter => hitter.avgHits);

List#min()

返回此集合中的最小值。如果任何值相当相等，则找到的第一个将被返回。

代码语言：javascript
复制
min(comparator?: (valueA: T, valueB: T) => number): T

Inherited from

Iterable#min

Discussion

在comparator以同样的方式使用Iterable#sort。如果未提供，则默认比较器为<。

当两个值被认为是等价的，遇到的第一个将被返回。否则，min只要比较器是可交换的，将独立于输入的顺序进行操作。默认比较器只有在类型不相同时才<可以交换。

如果comparator返回0，且其中任一值为NaN，undefined或null，则将返回该值。

List#minBy()

喜欢min，但也接受一个comparatorValueMapper允许通过更复杂的手段比较：

代码语言：javascript
复制
minBy<C>(comparatorValueMapper: (value?: T,key?: number,iter?: Iterable<number, T>) => C,comparator?: (valueA: C, valueB: C) => number): T

Inherited from

Iterable#minBy

Example

代码语言：javascript
复制
hitters.minBy(hitter => hitter.avgHits);

List#indexOf()

返回可以在Iterable中找到给定值的第一个索引，如果不存在则返回-1。

代码语言：javascript
复制
indexOf(searchValue: T): number

Inherited from

Iterable.Indexed#indexOf

List#lastIndexOf()

返回可以在Iterable中找到给定值的最后一个索引，如果不存在则返回-1。

代码语言：javascript
复制
lastIndexOf(searchValue: T): number

Inherited from

Iterable.Indexed#lastIndexOf

List#findIndex()

返回Iterable中的第一个索引，其中的值满足提供的谓词函数。否则返回-1。

代码语言：javascript
复制
findIndex(predicate: (value?: T, index?: number, iter?: Iterable.Indexed<T>) => boolean,context?: any): number

Inherited from

Iterable.Indexed#findIndex

List#findLastIndex()

返回一个值满足提供的谓词函数的Iterable中的最后一个索引。否则返回-1。

代码语言：javascript
复制
findLastIndex(predicate: (value?: T, index?: number, iter?: Iterable.Indexed<T>) => boolean,context?: any): number

Inherited from

Iterable.Indexed#findLastIndex

Comparison

List#isSubset()

如果iter包含此Iterable中的每个值，则为真。

代码语言：javascript
复制
isSubset(iter: Iterable<any, T>): boolean
isSubset(iter: Array<T>): boolean

Inherited from

Iterable#isSubset

List#isSuperset()

如果此Iterable包含每个值，则为真iter。

代码语言：javascript
复制
isSuperset(iter: Iterable<any, T>): boolean
isSuperset(iter: Array<T>): boolean

Inherited from

Iterable#isSuperset

本文档系腾讯云开发者社区成员共同维护，如有问题请联系 cloudcommunity@tencent.com

扫码关注腾讯云开发者

领取腾讯云代金券