Skip to main content

Collection

Classes

Collection

Extended by

Type Parameters

Type Parameter
T

Implements

Constructors

Constructor
new Collection<T>(items?): Collection<T>;
Parameters
ParameterType
items?T[]
Returns

Collection<T>

Constructor
new Collection<T>(items?): Collection<T>;
Parameters
ParameterType
items?Collection<T>
Returns

Collection<T>

Constructor
new Collection<T>(...items): Collection<T>;
Parameters
ParameterType
...itemsT[]
Returns

Collection<T>

Accessors

empty
Get Signature
get empty(): boolean;
Returns

boolean

length
Get Signature
get length(): number;
Returns

number

Methods

[iterator]()
iterator: ArrayIterator<T>;
Returns

ArrayIterator<T>

Implementation of
Iterable.[iterator]
add()
add(...items): void;
Parameters
ParameterType
...itemsT[]
Returns

void

addRange()
addRange(items): void;

Adds the specified items to the end of the collection.

Parameters
ParameterType
itemsany
Returns

void

aggregate()
Call Signature
aggregate(func): T;
Parameters
ParameterType
func(prev, current) => T
Returns

T

Call Signature
aggregate<TAccumulate>(seed, func): TAccumulate;
Type Parameters
Type Parameter
TAccumulate
Parameters
ParameterType
seedTAccumulate
func(prev, current) => TAccumulate
Returns

TAccumulate

Call Signature
aggregate<TAccumulate, TResult>(
seed,
func,
resultSelector): TResult;
Type Parameters
Type Parameter
TAccumulate
TResult
Parameters
ParameterType
seedTAccumulate
func(prev, current) => TAccumulate
resultSelector(last) => TResult
Returns

TResult

all()
all(predicate): boolean;
Parameters
ParameterType
predicate(element) => boolean
Returns

boolean

alternate()
Call Signature
alternate(alternateValue): IEnumerable<T>;
Parameters
ParameterType
alternateValueT
Returns

IEnumerable<T>

Call Signature
alternate(alternateSequence): IEnumerable<T>;
Parameters
ParameterType
alternateSequence{ [x: number]: T; length: number; }
alternateSequence.lengthnumber
Returns

IEnumerable<T>

Call Signature
alternate(alternateSequence): IEnumerable<T>;
Parameters
ParameterType
alternateSequenceIEnumerable<T>
Returns

IEnumerable<T>

Call Signature
alternate(alternateSequence): IEnumerable<T>;
Parameters
ParameterType
alternateSequenceT[]
Returns

IEnumerable<T>

any()
any(predicate?): boolean;
Parameters
ParameterType
predicate?(element) => boolean
Returns

boolean

asEnumerable()
asEnumerable(): IEnumerable<T>;
Returns

IEnumerable<T>

average()
average(selector?): number;
Parameters
ParameterType
selector?(element) => number
Returns

number

buffer()
buffer(count): IEnumerable<T[]>;
Parameters
ParameterType
countnumber
Returns

IEnumerable<T[]>

cast()
cast<TResult>(): IEnumerable<TResult>;
Type Parameters
Type Parameter
TResult
Returns

IEnumerable<TResult>

catchError()
catchError(handler): IEnumerable<T>;
Parameters
ParameterType
handler(exception) => void
Returns

IEnumerable<T>

choose()
choose(selector): IEnumerable<T>;
Parameters
ParameterType
selector(element, index) => T
Returns

IEnumerable<T>

clear()
clear(): void;

Removes all items from the collection

Returns

void

collectionChanged()
collectionChanged(h): void;
Parameters
ParameterType
hAnyFunction
Returns

void

collectionChanged()
collectionChanged(h): void;
Parameters
ParameterType
hAnyFunction
Returns

void

concat()
Call Signature
concat(...sequences): IEnumerable<T>;
Parameters
ParameterType
...sequencesIEnumerable<T>[]
Returns

IEnumerable<T>

Call Signature
concat(...sequences): IEnumerable<T>;
Parameters
ParameterType
...sequencesobject[]
Returns

IEnumerable<T>

Call Signature
concat(...sequences): IEnumerable<T>;
Parameters
ParameterType
...sequencesT[]
Returns

IEnumerable<T>

constructor()
constructor(getEnumerator): never;
Parameters
ParameterType
getEnumerator() => IEnumerator<T>
Returns

never

contains()
Call Signature
contains(value): boolean;
Parameters
ParameterType
valueT
Returns

boolean

Call Signature
contains<TCompare>(value, compareSelector?): boolean;
Type Parameters
Type Parameter
TCompare
Parameters
ParameterType
valueT
compareSelector?(element) => TCompare
Returns

boolean

count()
count(predicate?): number;
Parameters
ParameterType
predicate?(element, index) => boolean
Returns

number

defaultIfEmpty()
defaultIfEmpty(defaultValue?): IEnumerable<T>;
Parameters
ParameterType
defaultValue?T
Returns

IEnumerable<T>

distinct()
Call Signature
distinct(): IEnumerable<T>;
Returns

IEnumerable<T>

Call Signature
distinct<TCompare>(compareSelector): IEnumerable<T>;
Type Parameters
Type Parameter
TCompare
Parameters
ParameterType
compareSelector(element) => TCompare
Returns

IEnumerable<T>

distinctUntilChanged()
Call Signature
distinctUntilChanged(): IEnumerable<T>;
Returns

IEnumerable<T>

Call Signature
distinctUntilChanged<TCompare>(compareSelector): IEnumerable<T>;
Type Parameters
Type Parameter
TCompare
Parameters
ParameterType
compareSelector(element) => TCompare
Returns

IEnumerable<T>

doAction()
Call Signature
doAction(action): IEnumerable<T>;
Parameters
ParameterType
action(element, index) => void
Returns

IEnumerable<T>

Call Signature
doAction(action): IEnumerable<T>;
Parameters
ParameterType
action(element, index) => boolean
Returns

IEnumerable<T>

elementAt()
elementAt(index): T;
Parameters
ParameterType
indexnumber
Returns

T

elementAtOrDefault()
elementAtOrDefault(index, defaultValue?): T;
Parameters
ParameterType
indexnumber
defaultValue?T
Returns

T

except()
Call Signature
except(second): IEnumerable<T>;
Parameters
ParameterType
second{ [x: number]: T; length: number; }
second.lengthnumber
Returns

IEnumerable<T>

Call Signature
except<TCompare>(second, compareSelector): IEnumerable<T>;
Type Parameters
Type Parameter
TCompare
Parameters
ParameterType
second{ [x: number]: T; length: number; }
second.lengthnumber
compareSelector(element) => TCompare
Returns

IEnumerable<T>

Call Signature
except(second): IEnumerable<T>;
Parameters
ParameterType
secondIEnumerable<T>
Returns

IEnumerable<T>

Call Signature
except<TCompare>(second, compareSelector): IEnumerable<T>;
Type Parameters
Type Parameter
TCompare
Parameters
ParameterType
secondIEnumerable<T>
compareSelector(element) => TCompare
Returns

IEnumerable<T>

Call Signature
except(second): IEnumerable<T>;
Parameters
ParameterType
secondT[]
Returns

IEnumerable<T>

Call Signature
except<TCompare>(second, compareSelector): IEnumerable<T>;
Type Parameters
Type Parameter
TCompare
Parameters
ParameterType
secondT[]
compareSelector(element) => TCompare
Returns

IEnumerable<T>

finallyAction()
finallyAction(finallyAction): IEnumerable<T>;
Parameters
ParameterType
finallyAction() => void
Returns

IEnumerable<T>

first()
first(predicate?): T;
Parameters
ParameterType
predicate?(element, index) => boolean
Returns

T

firstOrDefault()
firstOrDefault(predicate?, defaultValue?): T;
Parameters
ParameterType
predicate?T | ((element, index) => boolean)
defaultValue?T
Returns

T

flatten()
flatten(): IEnumerable<any>;
Returns

IEnumerable<any>

force()
force(): void;
Returns

void

forEach()
Call Signature
forEach(action): void;
Parameters
ParameterType
action(element, index) => void
Returns

void

Call Signature
forEach(action): void;
Parameters
ParameterType
action(element, index) => boolean
Returns

void

get()
get(index): T;
Parameters
ParameterType
indexnumber
Returns

T

getEnumerator()
getEnumerator(): IEnumerator<T>;
Returns

IEnumerator<T>

getItem()
getItem(index): T;
Parameters
ParameterType
indexany
Returns

T

groupBy()
Call Signature
groupBy<TKey>(keySelector): IEnumerable<IGrouping<TKey, T>>;
Type Parameters
Type Parameter
TKey
Parameters
ParameterType
keySelector(element) => TKey
Returns

IEnumerable<IGrouping<TKey, T>>

Call Signature
groupBy<TKey, TElement>(keySelector, elementSelector): IEnumerable<IGrouping<TKey, TElement>>;
Type Parameters
Type Parameter
TKey
TElement
Parameters
ParameterType
keySelector(element) => TKey
elementSelector(element) => TElement
Returns

IEnumerable<IGrouping<TKey, TElement>>

Call Signature
groupBy<TKey, TElement, TResult>(
keySelector,
elementSelector,
resultSelector): IEnumerable<TResult>;
Type Parameters
Type Parameter
TKey
TElement
TResult
Parameters
ParameterType
keySelector(element) => TKey
elementSelector(element) => TElement
resultSelector(key, element) => TResult
Returns

IEnumerable<TResult>

Call Signature
groupBy<TKey, TElement, TResult, TCompare>(
keySelector,
elementSelector,
resultSelector,
compareSelector): IEnumerable<TResult>;
Type Parameters
Type Parameter
TKey
TElement
TResult
TCompare
Parameters
ParameterType
keySelector(element) => TKey
elementSelector(element) => TElement
resultSelector(key, element) => TResult
compareSelector(element) => TCompare
Returns

IEnumerable<TResult>

groupJoin()
Call Signature
groupJoin<TInner, TKey, TResult>(
inner,
outerKeySelector,
innerKeySelector,
resultSelector,
compareSelector?): IEnumerable<TResult>;
Type Parameters
Type Parameter
TInner
TKey
TResult
Parameters
ParameterType
innerIEnumerable<TInner>
outerKeySelector(outer) => TKey
innerKeySelector(inner) => TKey
resultSelector(outer, inner) => TResult
compareSelector?(obj) => TKey
Returns

IEnumerable<TResult>

Call Signature
groupJoin<TInner, TKey, TResult>(
inner,
outerKeySelector,
innerKeySelector,
resultSelector,
compareSelector?): IEnumerable<TResult>;
Type Parameters
Type Parameter
TInner
TKey
TResult
Parameters
ParameterType
inner{ [x: number]: TInner; length: number; }
inner.lengthnumber
outerKeySelector(outer) => TKey
innerKeySelector(inner) => TKey
resultSelector(outer, inner) => TResult
compareSelector?(obj) => TKey
Returns

IEnumerable<TResult>

Call Signature
groupJoin<TInner, TKey, TResult>(
inner,
outerKeySelector,
innerKeySelector,
resultSelector,
compareSelector?): IEnumerable<TResult>;
Type Parameters
Type Parameter
TInner
TKey
TResult
Parameters
ParameterType
innerTInner[]
outerKeySelector(outer) => TKey
innerKeySelector(inner) => TKey
resultSelector(outer, inner) => TResult
compareSelector?(obj) => TKey
Returns

IEnumerable<TResult>

indexOf()
Call Signature
indexOf(item): number;
Parameters
ParameterType
itemT
Returns

number

Call Signature
indexOf(predicate): number;
Parameters
ParameterType
predicate(element, index) => boolean
Returns

number

insert()
Call Signature
insert(index, second): IEnumerable<T>;
Parameters
ParameterType
indexnumber
secondIEnumerable<T>
Returns

IEnumerable<T>

Call Signature
insert(index, second): IEnumerable<T>;
Parameters
ParameterType
indexnumber
second{ [x: number]: T; length: number; }
second.lengthnumber
Returns

IEnumerable<T>

insertAt()
insertAt(index, items): void;

Inserts the specified item into the collection at the specified index.

Parameters
ParameterType
indexnumber
itemsT | T[]
Returns

void

intersect()
Call Signature
intersect(second): IEnumerable<T>;
Parameters
ParameterType
second{ [x: number]: T; length: number; }
second.lengthnumber
Returns

IEnumerable<T>

Call Signature
intersect<TCompare>(second, compareSelector): IEnumerable<T>;
Type Parameters
Type Parameter
TCompare
Parameters
ParameterType
second{ [x: number]: T; length: number; }
second.lengthnumber
compareSelector(element) => TCompare
Returns

IEnumerable<T>

Call Signature
intersect(second): IEnumerable<T>;
Parameters
ParameterType
secondIEnumerable<T>
Returns

IEnumerable<T>

Call Signature
intersect<TCompare>(second, compareSelector): IEnumerable<T>;
Type Parameters
Type Parameter
TCompare
Parameters
ParameterType
secondIEnumerable<T>
compareSelector(element) => TCompare
Returns

IEnumerable<T>

Call Signature
intersect(second): IEnumerable<T>;
Parameters
ParameterType
secondT[]
Returns

IEnumerable<T>

Call Signature
intersect<TCompare>(second, compareSelector): IEnumerable<T>;
Type Parameters
Type Parameter
TCompare
Parameters
ParameterType
secondT[]
compareSelector(element) => TCompare
Returns

IEnumerable<T>

isEmpty()
isEmpty(): boolean;
Returns

boolean

itemAdded()
itemAdded(h): void;
Parameters
ParameterType
h(data?) => any
Returns

void

itemAdded()
itemAdded(h): void;
Parameters
ParameterType
hany
Returns

void

itemMoved()
itemMoved(h): void;
Parameters
ParameterType
h(data?) => any
Returns

void

itemMoved()
itemMoved(h): void;
Parameters
ParameterType
h(data?) => any
Returns

void

itemRemoved()
itemRemoved(h): void;
Parameters
ParameterType
h(data?) => any
Returns

void

itemRemoved()
itemRemoved(h): void;
Parameters
ParameterType
hany
Returns

void

join()
Call Signature
join<TInner, TKey, TResult>(
inner,
outerKeySelector,
innerKeySelector,
resultSelector,
compareSelector?): IEnumerable<TResult>;
Type Parameters
Type Parameter
TInner
TKey
TResult
Parameters
ParameterType
innerIEnumerable<TInner>
outerKeySelector(outer) => TKey
innerKeySelector(inner) => TKey
resultSelector(outer, inner) => TResult
compareSelector?(obj) => TKey
Returns

IEnumerable<TResult>

Call Signature
join<TInner, TKey, TResult>(
inner,
outerKeySelector,
innerKeySelector,
resultSelector,
compareSelector?): IEnumerable<TResult>;
Type Parameters
Type Parameter
TInner
TKey
TResult
Parameters
ParameterType
inner{ [x: number]: TInner; length: number; }
inner.lengthnumber
outerKeySelector(outer) => TKey
innerKeySelector(inner) => TKey
resultSelector(outer, inner) => TResult
compareSelector?(obj) => TKey
Returns

IEnumerable<TResult>

Call Signature
join<TInner, TKey, TResult>(
inner,
outerKeySelector,
innerKeySelector,
resultSelector,
compareSelector?): IEnumerable<TResult>;
Type Parameters
Type Parameter
TInner
TKey
TResult
Parameters
ParameterType
innerTInner[]
outerKeySelector(outer) => TKey
innerKeySelector(inner) => TKey
resultSelector(outer, inner) => TResult
compareSelector?(obj) => TKey
Returns

IEnumerable<TResult>

last()
last(predicate?): T;
Parameters
ParameterType
predicate?(element, index) => boolean
Returns

T

lastIndexOf()
Call Signature
lastIndexOf(item): number;
Parameters
ParameterType
itemT
Returns

number

Call Signature
lastIndexOf(predicate): number;
Parameters
ParameterType
predicate(element, index) => boolean
Returns

number

lastOrDefault()
lastOrDefault(predicate?, defaultValue?): T;
Parameters
ParameterType
predicate?T | ((element, index) => boolean)
defaultValue?T
Returns

T

letBind()
Call Signature
letBind<TResult>(func): IEnumerable<TResult>;
Type Parameters
Type Parameter
TResult
Parameters
ParameterType
func(source) => object
Returns

IEnumerable<TResult>

Call Signature
letBind<TResult>(func): IEnumerable<TResult>;
Type Parameters
Type Parameter
TResult
Parameters
ParameterType
func(source) => TResult[]
Returns

IEnumerable<TResult>

Call Signature
letBind<TResult>(func): IEnumerable<TResult>;
Type Parameters
Type Parameter
TResult
Parameters
ParameterType
func(source) => IEnumerable<TResult>
Returns

IEnumerable<TResult>

log()
Call Signature
log(): IEnumerable<T>;
Returns

IEnumerable<T>

Call Signature
log<TValue>(selector): IEnumerable<T>;
Type Parameters
Type Parameter
TValue
Parameters
ParameterType
selector(element) => TValue
Returns

IEnumerable<T>

max()
max(selector?): number;
Parameters
ParameterType
selector?(element) => number
Returns

number

maxBy()
maxBy<TKey>(keySelector): T;
Type Parameters
Type Parameter
TKey
Parameters
ParameterType
keySelector(element) => TKey
Returns

T

memoize()
memoize(): IDisposableEnumerable<T>;
Returns

IDisposableEnumerable<T>

merge()
Call Signature
merge<TResult>(...params): IEnumerable<T>;
Type Parameters
Type Parameter
TResult
Parameters
ParameterType
...paramsIEnumerable<T>[]
Returns

IEnumerable<T>

Call Signature
merge<TResult>(...params): IEnumerable<T>;
Type Parameters
Type Parameter
TResult
Parameters
ParameterType
...paramsobject[]
Returns

IEnumerable<T>

Call Signature
merge<TResult>(...params): IEnumerable<T>;
Type Parameters
Type Parameter
TResult
Parameters
ParameterType
...paramsT[][]
Returns

IEnumerable<T>

min()
min(selector?): number;
Parameters
ParameterType
selector?(element) => number
Returns

number

minBy()
minBy<TKey>(keySelector): T;
Type Parameters
Type Parameter
TKey
Parameters
ParameterType
keySelector(element) => TKey
Returns

T

move()
move(
oldIndex,
newIndex,
supressEvent?): T;
Parameters
ParameterType
oldIndexany
newIndexany
supressEvent?boolean
Returns

T

ofType()
ofType<TOf>(type): IEnumerable<TOf>;
Type Parameters
Type Parameter
TOf
Parameters
ParameterType
typeType<TOf>
Returns

IEnumerable<TOf>

orderBy()
orderBy<TKey>(keySelector): IOrderedEnumerable<T>;
Type Parameters
Type Parameter
TKey
Parameters
ParameterType
keySelector(element) => TKey
Returns

IOrderedEnumerable<T>

orderByDescending()
orderByDescending<TKey>(keySelector): IOrderedEnumerable<T>;
Type Parameters
Type Parameter
TKey
Parameters
ParameterType
keySelector(element) => TKey
Returns

IOrderedEnumerable<T>

pairwise()
pairwise<TResult>(selector): IEnumerable<TResult>;
Type Parameters
Type Parameter
TResult
Parameters
ParameterType
selector(prev, current) => TResult
Returns

IEnumerable<TResult>

partitionBy()
Call Signature
partitionBy<TKey>(keySelector): IEnumerable<IGrouping<TKey, any>>;
Type Parameters
Type Parameter
TKey
Parameters
ParameterType
keySelector(element) => TKey
Returns

IEnumerable<IGrouping<TKey, any>>

Call Signature
partitionBy<TKey, TElement>(keySelector, elementSelector): IEnumerable<IGrouping<TKey, TElement>>;
Type Parameters
Type Parameter
TKey
TElement
Parameters
ParameterType
keySelector(element) => TKey
elementSelector(element) => TElement
Returns

IEnumerable<IGrouping<TKey, TElement>>

Call Signature
partitionBy<TKey, TElement, TResult>(
keySelector,
elementSelector,
resultSelector): IEnumerable<TResult>;
Type Parameters
Type Parameter
TKey
TElement
TResult
Parameters
ParameterType
keySelector(element) => TKey
elementSelector(element) => TElement
resultSelector(key, element) => TResult
Returns

IEnumerable<TResult>

Call Signature
partitionBy<TKey, TElement, TResult, TCompare>(
keySelector,
elementSelector,
resultSelector,
compareSelector): IEnumerable<TResult>;
Type Parameters
Type Parameter
TKey
TElement
TResult
TCompare
Parameters
ParameterType
keySelector(element) => TKey
elementSelector(element) => TElement
resultSelector(key, element) => TResult
compareSelector(element) => TCompare
Returns

IEnumerable<TResult>

push()
push(item): number;
Parameters
ParameterType
itemT
Returns

number

remove()
remove(item): T;
Parameters
ParameterType
itemT
Returns

T

removeAt()
removeAt(index): T;

Removes the item at the specified index of the collection.

Parameters
ParameterType
indexnumber
Returns

T

removeRange()
removeRange(from, to): T[];
Parameters
ParameterType
fromnumber
tonumber
Returns

T[]

replaceAt()
replaceAt(item, index): void;
Parameters
ParameterType
itemT
indexnumber
Returns

void

reverse()
reverse(): IEnumerable<T>;
Returns

IEnumerable<T>

scan()
Call Signature
scan(func): IEnumerable<T>;
Parameters
ParameterType
func(prev, current) => T
Returns

IEnumerable<T>

Call Signature
scan<TAccumulate>(seed, func): IEnumerable<TAccumulate>;
Type Parameters
Type Parameter
TAccumulate
Parameters
ParameterType
seedTAccumulate
func(prev, current) => TAccumulate
Returns

IEnumerable<TAccumulate>

select()
select<TResult>(selector): IEnumerable<TResult>;
Type Parameters
Type Parameter
TResult
Parameters
ParameterType
selector(element, index) => TResult
Returns

IEnumerable<TResult>

selectMany()
Call Signature
selectMany<TOther>(collectionSelector): IEnumerable<TOther>;
Type Parameters
Type Parameter
TOther
Parameters
ParameterType
collectionSelector(element, index) => IEnumerable<TOther>
Returns

IEnumerable<TOther>

Call Signature
selectMany<TCollection, TResult>(collectionSelector, resultSelector): IEnumerable<TResult>;
Type Parameters
Type Parameter
TCollection
TResult
Parameters
ParameterType
collectionSelector(element, index) => IEnumerable<TCollection>
resultSelector(outer, inner) => TResult
Returns

IEnumerable<TResult>

Call Signature
selectMany<TOther>(collectionSelector): IEnumerable<TOther>;
Type Parameters
Type Parameter
TOther
Parameters
ParameterType
collectionSelector(element, index) => TOther[]
Returns

IEnumerable<TOther>

Call Signature
selectMany<TCollection, TResult>(collectionSelector, resultSelector): IEnumerable<TResult>;
Type Parameters
Type Parameter
TCollection
TResult
Parameters
ParameterType
collectionSelector(element, index) => TCollection[]
resultSelector(outer, inner) => TResult
Returns

IEnumerable<TResult>

Call Signature
selectMany<TOther>(collectionSelector): IEnumerable<TOther>;
Type Parameters
Type Parameter
TOther
Parameters
ParameterType
collectionSelector(element, index) => object
Returns

IEnumerable<TOther>

Call Signature
selectMany<TCollection, TResult>(collectionSelector, resultSelector): IEnumerable<TResult>;
Type Parameters
Type Parameter
TCollection
TResult
Parameters
ParameterType
collectionSelector(element, index) => object
resultSelector(outer, inner) => TResult
Returns

IEnumerable<TResult>

sequenceEqual()
Call Signature
sequenceEqual(second): boolean;
Parameters
ParameterType
second{ [x: number]: T; length: number; }
second.lengthnumber
Returns

boolean

Call Signature
sequenceEqual<TCompare>(second, compareSelector): boolean;
Type Parameters
Type Parameter
TCompare
Parameters
ParameterType
second{ [x: number]: T; length: number; }
second.lengthnumber
compareSelector(element) => TCompare
Returns

boolean

Call Signature
sequenceEqual(second): boolean;
Parameters
ParameterType
secondIEnumerable<T>
Returns

boolean

Call Signature
sequenceEqual<TCompare>(second, compareSelector): boolean;
Type Parameters
Type Parameter
TCompare
Parameters
ParameterType
secondIEnumerable<T>
compareSelector(element) => TCompare
Returns

boolean

Call Signature
sequenceEqual(second): boolean;
Parameters
ParameterType
secondT[]
Returns

boolean

Call Signature
sequenceEqual<TCompare>(second, compareSelector): boolean;
Type Parameters
Type Parameter
TCompare
Parameters
ParameterType
secondT[]
compareSelector(element) => TCompare
Returns

boolean

set()
set(index, value): void;
Parameters
ParameterType
indexnumber
valueT
Returns

void

setRange()
setRange(items): void;
Parameters
ParameterType
itemsany
Returns

void

share()
share(): IDisposableEnumerable<T>;
Returns

IDisposableEnumerable<T>

shuffle()
shuffle(): IEnumerable<T>;
Returns

IEnumerable<T>

single()
single(predicate?): T;
Parameters
ParameterType
predicate?(element, index) => boolean
Returns

T

singleOrDefault()
singleOrDefault(predicate?, defaultValue?): T;
Parameters
ParameterType
predicate?(element, index) => boolean
defaultValue?T
Returns

T

skip()
skip(count): IEnumerable<T>;
Parameters
ParameterType
countnumber
Returns

IEnumerable<T>

skipWhile()
skipWhile(predicate): IEnumerable<T>;
Parameters
ParameterType
predicate(element, index) => boolean
Returns

IEnumerable<T>

sum()
sum(selector?): number;
Parameters
ParameterType
selector?(element) => number
Returns

number

take()
take(count): IEnumerable<T>;
Parameters
ParameterType
countnumber
Returns

IEnumerable<T>

takeExceptLast()
takeExceptLast(count?): IEnumerable<T>;
Parameters
ParameterType
count?number
Returns

IEnumerable<T>

takeFromLast()
takeFromLast(count): IEnumerable<T>;
Parameters
ParameterType
countnumber
Returns

IEnumerable<T>

takeWhile()
takeWhile(predicate): IEnumerable<T>;
Parameters
ParameterType
predicate(element, index) => boolean
Returns

IEnumerable<T>

toArray()
toArray(): T[];
Returns

T[]

toDictionary()
Call Signature
toDictionary<TKey>(keySelector): IDictionary<TKey, any>;
Type Parameters
Type Parameter
TKey
Parameters
ParameterType
keySelector(element) => TKey
Returns

IDictionary<TKey, any>

Call Signature
toDictionary<TKey, TValue>(keySelector, elementSelector): IDictionary<TKey, TValue>;
Type Parameters
Type Parameter
TKey
TValue
Parameters
ParameterType
keySelector(element) => TKey
elementSelector(element) => TValue
Returns

IDictionary<TKey, TValue>

Call Signature
toDictionary<TKey, TValue, TCompare>(
keySelector,
elementSelector,
compareSelector): IDictionary<TKey, TValue>;
Type Parameters
Type Parameter
TKey
TValue
TCompare
Parameters
ParameterType
keySelector(element) => TKey
elementSelector(element) => TValue
compareSelector(key) => TCompare
Returns

IDictionary<TKey, TValue>

toJoinedString()
Call Signature
toJoinedString(separator?): string;
Parameters
ParameterType
separator?string
Returns

string

Call Signature
toJoinedString<TResult>(separator, selector): string;
Type Parameters
Type Parameter
TResult
Parameters
ParameterType
separatorstring
selector(element, index) => TResult
Returns

string

toJSONString()
Call Signature
toJSONString(replacer): string;
Parameters
ParameterType
replacer(key, value) => any
Returns

string

Call Signature
toJSONString(replacer): string;
Parameters
ParameterType
replacerany[]
Returns

string

Call Signature
toJSONString(replacer, space): string;
Parameters
ParameterType
replacer(key, value) => any
spaceany
Returns

string

Call Signature
toJSONString(replacer, space): string;
Parameters
ParameterType
replacerany[]
spaceany
Returns

string

toLookup()
Call Signature
toLookup<TKey>(keySelector): ILookup<TKey, T>;
Type Parameters
Type Parameter
TKey
Parameters
ParameterType
keySelector(element) => TKey
Returns

ILookup<TKey, T>

Call Signature
toLookup<TKey, TElement>(keySelector, elementSelector): ILookup<TKey, TElement>;
Type Parameters
Type Parameter
TKey
TElement
Parameters
ParameterType
keySelector(element) => TKey
elementSelector(element) => TElement
Returns

ILookup<TKey, TElement>

Call Signature
toLookup<TKey, TElement, TCompare>(
keySelector,
elementSelector,
compareSelector): ILookup<TKey, TElement>;
Type Parameters
Type Parameter
TKey
TElement
TCompare
Parameters
ParameterType
keySelector(element) => TKey
elementSelector(element) => TElement
compareSelector(key) => TCompare
Returns

ILookup<TKey, TElement>

toObject()
toObject(keySelector, elementSelector?): Object;
Parameters
ParameterType
keySelector(element) => any
elementSelector?(element) => any
Returns

Object

trace()
Call Signature
trace(message?): IEnumerable<T>;
Parameters
ParameterType
message?string
Returns

IEnumerable<T>

Call Signature
trace<TValue>(message, selector): IEnumerable<T>;
Type Parameters
Type Parameter
TValue
Parameters
ParameterType
messagestring
selector(element) => TValue
Returns

IEnumerable<T>

traverseBreadthFirst()
Call Signature
traverseBreadthFirst(childrenSelector): IEnumerable<T>;
Parameters
ParameterType
childrenSelector(element) => IEnumerable<T>
Returns

IEnumerable<T>

Call Signature
traverseBreadthFirst<TResult>(childrenSelector, resultSelector): IEnumerable<TResult>;
Type Parameters
Type Parameter
TResult
Parameters
ParameterType
childrenSelector(element) => IEnumerable<T>
resultSelector(element, nestLevel) => TResult
Returns

IEnumerable<TResult>

traverseDepthFirst()
Call Signature
traverseDepthFirst<TResult>(childrenSelector): IEnumerable<T>;
Type Parameters
Type Parameter
TResult
Parameters
ParameterType
childrenSelector(element) => IEnumerable<T>
Returns

IEnumerable<T>

Call Signature
traverseDepthFirst<TResult>(childrenSelector, resultSelector?): IEnumerable<TResult>;
Type Parameters
Type Parameter
TResult
Parameters
ParameterType
childrenSelector(element) => IEnumerable<T>
resultSelector?(element, nestLevel) => TResult
Returns

IEnumerable<TResult>

union()
Call Signature
union(second): IEnumerable<T>;
Parameters
ParameterType
second{ [x: number]: T; length: number; }
second.lengthnumber
Returns

IEnumerable<T>

Call Signature
union<TCompare>(second, compareSelector): IEnumerable<T>;
Type Parameters
Type Parameter
TCompare
Parameters
ParameterType
second{ [x: number]: T; length: number; }
second.lengthnumber
compareSelector(element) => TCompare
Returns

IEnumerable<T>

Call Signature
union(second): IEnumerable<T>;
Parameters
ParameterType
secondIEnumerable<T>
Returns

IEnumerable<T>

Call Signature
union<TCompare>(second, compareSelector): IEnumerable<T>;
Type Parameters
Type Parameter
TCompare
Parameters
ParameterType
secondIEnumerable<T>
compareSelector(element) => TCompare
Returns

IEnumerable<T>

Call Signature
union(second): IEnumerable<T>;
Parameters
ParameterType
secondT[]
Returns

IEnumerable<T>

Call Signature
union<TCompare>(second, compareSelector): IEnumerable<T>;
Type Parameters
Type Parameter
TCompare
Parameters
ParameterType
secondT[]
compareSelector(element) => TCompare
Returns

IEnumerable<T>

weightedSample()
weightedSample(weightSelector): IEnumerable<T>;
Parameters
ParameterType
weightSelector(element) => number
Returns

IEnumerable<T>

where()
where(predicate): IEnumerable<T>;
Parameters
ParameterType
predicate(element, index) => boolean
Returns

IEnumerable<T>

write()
Call Signature
write(separator?): void;
Parameters
ParameterType
separator?string
Returns

void

Call Signature
write<TResult>(separator, selector): void;
Type Parameters
Type Parameter
TResult
Parameters
ParameterType
separatorstring
selector(element) => TResult
Returns

void

writeLine()
Call Signature
writeLine(): void;
Returns

void

Call Signature
writeLine<TResult>(selector): void;
Type Parameters
Type Parameter
TResult
Parameters
ParameterType
selector(element) => TResult
Returns

void

zip()
Call Signature
zip<TResult>(second, resultSelector): IEnumerable<TResult>;
Type Parameters
Type Parameter
TResult
Parameters
ParameterType
secondIEnumerable<T>
resultSelector(first, second, index) => TResult
Returns

IEnumerable<TResult>

Call Signature
zip<TResult>(second, resultSelector): IEnumerable<TResult>;
Type Parameters
Type Parameter
TResult
Parameters
ParameterType
second{ [x: number]: T; length: number; }
second.lengthnumber
resultSelector(first, second, index) => TResult
Returns

IEnumerable<TResult>

Call Signature
zip<TResult>(second, resultSelector): IEnumerable<TResult>;
Type Parameters
Type Parameter
TResult
Parameters
ParameterType
secondT[]
resultSelector(first, second, index) => TResult
Returns

IEnumerable<TResult>

Call Signature
zip<TResult>(...params): IEnumerable<TResult>;
Type Parameters
Type Parameter
TResult
Parameters
ParameterType
...paramsany[]
Returns

IEnumerable<TResult>

Was this page helpful?