Enumerable | TypeScript.NET

Enumerable is a wrapper class that allows more primitive enumerables to exhibit LINQ behavior.

In C# Enumerable is not an instance but has extensions for IEnumerable. In this case, we use Enumerable as the underlying class that is being chained.

Type parameters

Hierarchy

InfiniteEnumerable<T>
- Enumerable
  - FiniteEnumerable

Implements

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Enumerable(enumeratorFactory: function, finalizer?: function, isEndless?: boolean): Enumerable

Overwrites InfiniteEnumerable.constructor
- Defined in source/System.Linq/Linq.ts:1827
Parameters
- enumeratorFactory: function
  - - (): IEnumerator<T>
    - Returns IEnumerator<T>
- Optional finalizer: function
  - - (): void
    - Returns void
- Default value isEndless: boolean = null
Returns Enumerable

Properties

Protected _disposableObjectName

_disposableObjectName: string

Protected _enumeratorFactory

_enumeratorFactory: function

Type declaration

- (): IEnumerator<T>
- Returns IEnumerator<T>

Protected _isEndless

_isEndless: boolean

Accessors

isEndless

get isEndless(): boolean

Inherited from InfiniteEnumerable.isEndless
- Defined in source/System.Linq/Linq.ts:111
Returns boolean

wasDisposed

get wasDisposed(): boolean

Inherited from DisposableBase.wasDisposed
- Defined in source/System/Disposable/DisposableBase.ts:18
Returns boolean

Methods

Protected _choose

_choose<TResult>(selector: Selector<T, TResult>): Enumerable<TResult>

Inherited from InfiniteEnumerable._choose
- Defined in source/System.Linq/Linq.ts:859
Type parameters
- TResult
Parameters
- selector: Selector<T, TResult>
Returns Enumerable<TResult>

Protected _onDispose

_onDispose(): void

Inherited from InfiniteEnumerable._onDispose

Overwrites DisposableBase._onDispose
- Defined in source/System.Linq/Linq.ts:128
Returns void

Protected _selectMany

_selectMany<TElement, TResult>(collectionSelector: Selector<T, IEnumerableOrArray>, resultSelector?: function): Enumerable<TResult>

Inherited from InfiniteEnumerable._selectMany
- Defined in source/System.Linq/Linq.ts:765
Type parameters
- TElement
- TResult
Parameters
- collectionSelector: Selector<T, IEnumerableOrArray>
- Optional resultSelector: function
  - - (collection: T, element: TElement): TResult
    - Parameters
      - collection: T
      - element: TElement
      Returns TResult
Returns Enumerable<TResult>

aggregate

aggregate(func: function, seed?: T): T

- Defined in source/System.Linq/Linq.ts:3187
Parameters
- func: function
  - - (a: T, b: T): T
    - Parameters
      - a: T
      - b: T
      Returns T
- Optional seed: T
Returns T

all

all(predicate: Predicate<T>): boolean

Implementation of ILinqEnumerable.all
- Defined in source/System.Linq/Linq.ts:2795
Parameters
- predicate: Predicate<T>
Returns boolean

alternate

alternate(...sequence: T[])

Implementation of ILinqEnumerable.alternate

Inherited from InfiniteEnumerable.alternate
- Defined in source/System.Linq/Linq.ts:1653
Parameters
- Rest ...sequence: T[]

alternateMultiple

alternateMultiple(sequence: IEnumerableOrArray)

Implementation of ILinqEnumerable.alternateMultiple

Inherited from InfiniteEnumerable.alternateMultiple
- Defined in source/System.Linq/Linq.ts:1571
Parameters
- sequence: IEnumerableOrArray

alternateSingle

alternateSingle(value: T)

Implementation of ILinqEnumerable.alternateSingle

Inherited from InfiniteEnumerable.alternateSingle
- Defined in source/System.Linq/Linq.ts:1648
Parameters
- value: T

any

any(predicate?: Predicate<T>): boolean

Implementation of ILinqEnumerable.any

Overwrites InfiniteEnumerable.any
- Defined in source/System.Linq/Linq.ts:2819
Parameters
- Optional predicate: Predicate<T>
Returns boolean

asEnumerable

asEnumerable()

Implementation of ILinqEnumerable.asEnumerable

Overwrites InfiniteEnumerable.asEnumerable
- Defined in source/System.Linq/Linq.ts:2417

average

average(selector?: Selector<T, number>): number

Implementation of ILinqEnumerable.average
- Defined in source/System.Linq/Linq.ts:3194
Parameters
- Default value selector: Selector<T, number> = Type.numberOrNaN
Returns number

buffer

buffer(size: number): Enumerable<T[]>

Implementation of ILinqEnumerable.buffer

Overwrites InfiniteEnumerable.buffer
- Defined in source/System.Linq/Linq.ts:3071
Parameters
- size: number
Returns Enumerable<T[]>

catchError

catchError(handler: function)

Inherited from InfiniteEnumerable.catchError
- Defined in source/System.Linq/Linq.ts:1660
Parameters
- handler: function
  - - (e: any): void
    - Parameters
      - e: any
      Returns void

choose

choose(): Enumerable<T>
choose<TResult>(selector?: Selector<T, TResult>): Enumerable<TResult>

Implementation of ILinqEnumerable.choose

Overwrites InfiniteEnumerable.choose
- Defined in source/System.Linq/Linq.ts:2678
Returns Enumerable<T>
Implementation of ILinqEnumerable.choose

Overwrites InfiniteEnumerable.choose
- Defined in source/System.Linq/Linq.ts:2679
Type parameters
- TResult
Parameters
- Optional selector: Selector<T, TResult>
Returns Enumerable<TResult>

concat

concat(...enumerables: Array<IEnumerableOrArray>)

Implementation of ILinqEnumerable.concat

Inherited from InfiniteEnumerable.concat
- Defined in source/System.Linq/Linq.ts:1442
Parameters
- Rest ...enumerables: Array<IEnumerableOrArray>

contains

contains<TCompare>(value: T, compareSelector?: Selector<T, TCompare>): boolean

Implementation of ILinqEnumerable.contains
- Defined in source/System.Linq/Linq.ts:2844
Type parameters
- TCompare
Parameters
- value: T
- Optional compareSelector: Selector<T, TCompare>
Returns boolean

copyTo

copyTo(target: T[], index?: number, count?: number): T[]

Implementation of ILinqEnumerable.copyTo
- Defined in source/System.Linq/Linq.ts:2523
Parameters
- target: T[]
- Default value index: number = 0
- Default value count: number = Infinity
Returns T[]

count

count(predicate?: Predicate<T>): number

Implementation of ILinqEnumerable.count
- Defined in source/System.Linq/Linq.ts:2772
Parameters
- Optional predicate: Predicate<T>
Returns number

defaultIfEmpty

defaultIfEmpty(defaultValue?: T)

Implementation of ILinqEnumerable.defaultIfEmpty

Inherited from InfiniteEnumerable.defaultIfEmpty
- Defined in source/System.Linq/Linq.ts:1126
Returns a single default value if empty.

Parameters
- Default value defaultValue: T = null

dispose

dispose(): void

Implementation of ILinqEnumerable.dispose

Inherited from DisposableBase.dispose
- Defined in source/System/Disposable/DisposableBase.ts:36
Returns void

distinct

distinct(compareSelector?: function)

Inherited from InfiniteEnumerable.distinct
- Defined in source/System.Linq/Linq.ts:1055
Parameters
- Optional compareSelector: function
  - - (value: T): T
    - Parameters
      - value: T
      Returns T

distinctUntilChanged

distinctUntilChanged<TCompare>(compareSelector?: Selector<T, TCompare>)

Implementation of ILinqEnumerable.distinctUntilChanged

Inherited from InfiniteEnumerable.distinctUntilChanged
- Defined in source/System.Linq/Linq.ts:1061
Type parameters
- TCompare
Parameters
- Default value compareSelector: Selector<T, TCompare> = Functions.Identity

doAction

doAction(action: Action<T> | Predicate<T> | Selector<T, number> | Selector<T, EnumerableAction>, initializer?: function, isEndless?: boolean)

Inherited from InfiniteEnumerable.doAction
- Defined in source/System.Linq/Linq.ts:151
Similar to forEach, but executes an action for each time a value is enumerated. If the action explicitly returns false or 0 (EnumerationAction.Break), the enumeration will complete. If it returns a 2 (EnumerationAction.Skip) it will move on to the next item. This also automatically handles disposing the enumerator.

Parameters
- action: Action<T> | Predicate<T> | Selector<T, number> | Selector<T, EnumerableAction>
- Optional initializer: function
  - - (): void
    - Returns void
- Default value isEndless: boolean = this.isEndless

elementAt

elementAt(index: number): T

Implementation of ILinqEnumerable.elementAt

Inherited from InfiniteEnumerable.elementAt
- Defined in source/System.Linq/Linq.ts:265
Parameters
- index: number
Returns T

elementAtOrDefault

elementAtOrDefault(index: number, defaultValue?: T): T

Implementation of ILinqEnumerable.elementAtOrDefault

Inherited from InfiniteEnumerable.elementAtOrDefault
- Defined in source/System.Linq/Linq.ts:272
Parameters
- index: number
- Default value defaultValue: T = null
Returns T

every

every(predicate: Predicate<T>): boolean

Implementation of ILinqEnumerable.every
- Defined in source/System.Linq/Linq.ts:2813
Parameters
- predicate: Predicate<T>
Returns boolean

except

except<TCompare>(second: IEnumerableOrArray, compareSelector?: Selector<T, TCompare>)

Implementation of ILinqEnumerable.except

Inherited from InfiniteEnumerable.except
- Defined in source/System.Linq/Linq.ts:999
Type parameters
- TCompare
Parameters
- second: IEnumerableOrArray
- Optional compareSelector: Selector<T, TCompare>

finallyAction

finallyAction(action: function)

Inherited from InfiniteEnumerable.finallyAction
- Defined in source/System.Linq/Linq.ts:1706
Parameters
- action: function
  - - (): void
    - Returns void

first

first(): T

Implementation of ILinqEnumerable.first

Inherited from InfiniteEnumerable.first
- Defined in source/System.Linq/Linq.ts:304
Returns T

firstOrDefault

firstOrDefault(defaultValue?: T): T

Implementation of ILinqEnumerable.firstOrDefault

Inherited from InfiniteEnumerable.firstOrDefault
- Defined in source/System.Linq/Linq.ts:311
Parameters
- Default value defaultValue: T = null
Returns T

flatten

flatten(): Enumerable<any>

Implementation of ILinqEnumerable.flatten

Inherited from InfiniteEnumerable.flatten
- Defined in source/System.Linq/Linq.ts:550
Returns Enumerable<any>

forEach

forEach(action: Predicate<T> | Action<T>): void

Implementation of ILinqEnumerable.forEach
- Defined in source/System.Linq/Linq.ts:2491
Parameters
- action: Predicate<T> | Action<T>
Returns void

force

force(): void

Implementation of ILinqEnumerable.force

Inherited from InfiniteEnumerable.force
- Defined in source/System.Linq/Linq.ts:217
Returns void

getEnumerator

getEnumerator(): IEnumerator<T>

Implementation of ILinqEnumerable.getEnumerator

Inherited from InfiniteEnumerable.getEnumerator
- Defined in source/System.Linq/Linq.ts:117
Returns IEnumerator<T>

groupBy

groupBy<TKey>(keySelector: Selector<T, TKey>): Enumerable<IGrouping<TKey, T>>
groupBy<TKey, TCompare>(keySelector: Selector<T, TKey>, elementSelector?: Selector<T, T>, compareSelector?: Selector<TKey, TCompare>): Enumerable<IGrouping<TKey, T>>

Implementation of ILinqEnumerable.groupBy
- Defined in source/System.Linq/Linq.ts:3081
Type parameters
- TKey
Parameters
- keySelector: Selector<T, TKey>
Returns Enumerable<IGrouping<TKey, T>>
Implementation of ILinqEnumerable.groupBy
- Defined in source/System.Linq/Linq.ts:3082
Type parameters
- TKey
- TCompare
Parameters
- keySelector: Selector<T, TKey>
- Optional elementSelector: Selector<T, T>
- Optional compareSelector: Selector<TKey, TCompare>
Returns Enumerable<IGrouping<TKey, T>>

groupJoin

groupJoin<TInner, TKey, TResult, TCompare>(inner: IEnumerableOrArray, outerKeySelector: Selector<T, TKey>, innerKeySelector: Selector<TInner, TKey>, resultSelector: function, compareSelector?: Selector<TKey, TCompare>): Enumerable<TResult>

Inherited from InfiniteEnumerable.groupJoin
- Defined in source/System.Linq/Linq.ts:1342
Type parameters
- TInner
- TKey
- TResult
- TCompare
Parameters
- inner: IEnumerableOrArray
- outerKeySelector: Selector<T, TKey>
- innerKeySelector: Selector<TInner, TKey>
- resultSelector: function
  - - (outer: T, inner: TInner[]): TResult
    - Parameters
      - outer: T
      - inner: TInner[]
      Returns TResult
- Default value compareSelector: Selector<TKey, TCompare> = Functions.Identity
Returns Enumerable<TResult>

indexOf

indexOf<TCompare>(value: T, compareSelector?: Selector<T, TCompare>): number

Implementation of ILinqEnumerable.indexOf
- Defined in source/System.Linq/Linq.ts:2854
Type parameters
- TCompare
Parameters
- value: T
- Optional compareSelector: Selector<T, TCompare>
Returns number

insertAt

insertAt(index: number, other: IEnumerableOrArray)

Implementation of ILinqEnumerable.insertAt

Inherited from InfiniteEnumerable.insertAt
- Defined in source/System.Linq/Linq.ts:1509
Parameters
- index: number
- other: IEnumerableOrArray

intersect

intersect<TCompare>(second: IEnumerableOrArray, compareSelector?: Selector<T, TCompare>)

Implementation of ILinqEnumerable.intersect
- Defined in source/System.Linq/Linq.ts:2905
Type parameters
- TCompare
Parameters
- second: IEnumerableOrArray
- Optional compareSelector: Selector<T, TCompare>

isEmpty

isEmpty(): boolean

Implementation of ILinqEnumerable.isEmpty

Inherited from InfiniteEnumerable.isEmpty
- Defined in source/System.Linq/Linq.ts:374
Returns boolean

join

join<TInner, TKey, TResult, TCompare>(inner: IEnumerableOrArray, outerKeySelector: Selector<T, TKey>, innerKeySelector: Selector<TInner, TKey>, resultSelector: function, compareSelector?: Selector<TKey, TCompare>): Enumerable<TResult>

Inherited from InfiniteEnumerable.join
- Defined in source/System.Linq/Linq.ts:1282
Type parameters
- TInner
- TKey
- TResult
- TCompare
Parameters
- inner: IEnumerableOrArray
- outerKeySelector: Selector<T, TKey>
- innerKeySelector: Selector<TInner, TKey>
- resultSelector: function
  - - (outer: T, inner: TInner): TResult
    - Parameters
      - outer: T
      - inner: TInner
      Returns TResult
- Default value compareSelector: Selector<TKey, TCompare> = Functions.Identity
Returns Enumerable<TResult>

last

last(): T

Implementation of ILinqEnumerable.last
- Defined in source/System.Linq/Linq.ts:3334
Returns T

lastIndexOf

lastIndexOf<TCompare>(value: T, compareSelector?: Selector<T, TCompare>): number

Implementation of ILinqEnumerable.lastIndexOf
- Defined in source/System.Linq/Linq.ts:2883
Type parameters
- TCompare
Parameters
- value: T
- Optional compareSelector: Selector<T, TCompare>
Returns number

lastOrDefault

lastOrDefault(defaultValue?: T): T

Implementation of ILinqEnumerable.lastOrDefault
- Defined in source/System.Linq/Linq.ts:3353
Parameters
- Default value defaultValue: T = null
Returns T

max

max(): T

Implementation of ILinqEnumerable.max
- Defined in source/System.Linq/Linq.ts:3209
Returns T

maxBy

maxBy<TCompare>(keySelector?: Selector<T, TCompare>): T

Implementation of ILinqEnumerable.maxBy
- Defined in source/System.Linq/Linq.ts:3219
Type parameters
- TCompare
Parameters
- Default value keySelector: Selector<T, TCompare> = Functions.Identity
Returns T

memoize

memoize()

Implementation of ILinqEnumerable.memoize
- Defined in source/System.Linq/Linq.ts:3372

merge

merge(enumerables: IArray)

Implementation of ILinqEnumerable.merge

Inherited from InfiniteEnumerable.merge
- Defined in source/System.Linq/Linq.ts:1384
Parameters
- enumerables: IArray

min

min(): T

Implementation of ILinqEnumerable.min
- Defined in source/System.Linq/Linq.ts:3214
Returns T

minBy

minBy<TCompare>(keySelector?: Selector<T, TCompare>): T

Implementation of ILinqEnumerable.minBy
- Defined in source/System.Linq/Linq.ts:3224
Type parameters
- TCompare
Parameters
- Default value keySelector: Selector<T, TCompare> = Functions.Identity
Returns T

ofType

ofType<TType>(type: object): Enumerable<TType>

Overwrites InfiniteEnumerable.ofType
- Defined in source/System.Linq/Linq.ts:2995
Type parameters
- TType
Parameters
- type: object
Returns Enumerable<TType>

orderBy

orderBy<TKey>(keySelector?: Selector<T, TKey>): IOrderedEnumerable<T>

Implementation of ILinqEnumerable.orderBy
- Defined in source/System.Linq/Linq.ts:3003
Type parameters
- TKey: Comparable
Parameters
- Default value keySelector: Selector<T, TKey> = Functions.Identity
Returns IOrderedEnumerable<T>

orderByDescending

orderByDescending<TKey>(keySelector?: Selector<T, TKey>): IOrderedEnumerable<T>

Implementation of ILinqEnumerable.orderByDescending
- Defined in source/System.Linq/Linq.ts:3018
Type parameters
- TKey: Comparable
Parameters
- Default value keySelector: Selector<T, TKey> = Functions.Identity
Returns IOrderedEnumerable<T>

orderUsing

orderUsing(comparison: Comparison<T>): IOrderedEnumerable<T>

Implementation of ILinqEnumerable.orderUsing
- Defined in source/System.Linq/Linq.ts:3008
Parameters
- comparison: Comparison<T>
Returns IOrderedEnumerable<T>

orderUsingReversed

orderUsingReversed(comparison: Comparison<T>): IOrderedEnumerable<T>

Implementation of ILinqEnumerable.orderUsingReversed
- Defined in source/System.Linq/Linq.ts:3013
Parameters
- comparison: Comparison<T>
Returns IOrderedEnumerable<T>

pairwise

pairwise<TSelect>(selector: function): Enumerable<TSelect>

Inherited from InfiniteEnumerable.pairwise
- Defined in source/System.Linq/Linq.ts:622
Type parameters
- TSelect
Parameters
- selector: function
  - - (prev: T, current: T): TSelect
    - Parameters
      - prev: T
      - current: T
      Returns TSelect
Returns Enumerable<TSelect>

partitionBy

partitionBy<TKey>(keySelector: Selector<T, TKey>): Enumerable<IGrouping<TKey, T>>
partitionBy<TKey, TElement, TCompare>(keySelector: Selector<T, TKey>, elementSelector: Selector<T, TElement>, resultSelector?: function, compareSelector?: Selector<TKey, TCompare>): Enumerable<IGrouping<TKey, TElement>>

Implementation of ILinqEnumerable.partitionBy
- Defined in source/System.Linq/Linq.ts:3098
Type parameters
- TKey
Parameters
- keySelector: Selector<T, TKey>
Returns Enumerable<IGrouping<TKey, T>>
- Defined in source/System.Linq/Linq.ts:3099
Type parameters
- TKey
- TElement
- TCompare
Parameters
- keySelector: Selector<T, TKey>
- elementSelector: Selector<T, TElement>
- Optional resultSelector: function
  - - (key: TKey, element: TElement[]): IGrouping<TKey, TElement>
    - Parameters
      - key: TKey
      - element: TElement[]
      Returns IGrouping<TKey, TElement>
- Optional compareSelector: Selector<TKey, TCompare>
Returns Enumerable<IGrouping<TKey, TElement>>

product

product(selector?: Selector<T, number>): number

Implementation of ILinqEnumerable.product
- Defined in source/System.Linq/Linq.ts:3260
Parameters
- Default value selector: Selector<T, number> = Type.numberOrNaN
Returns number

quotient

quotient(selector?: Selector<T, number>): number

Implementation of ILinqEnumerable.quotient
- Defined in source/System.Linq/Linq.ts:3295
Takes the first number and divides it by all following.

Parameters
- Default value selector: Selector<T, number> = Type.numberOrNaN
Returns number

reverse

reverse()

Implementation of ILinqEnumerable.reverse
- Defined in source/System.Linq/Linq.ts:2685

scan

scan(func: function, seed?: T)

Inherited from InfiniteEnumerable.scan
- Defined in source/System.Linq/Linq.ts:659
Parameters
- func: function
  - - (a: T, b: T): T
    - Parameters
      - a: T
      - b: T
      Returns T
- Optional seed: T

select

select<TResult>(selector: Selector<T, TResult>): Enumerable<TResult>

Implementation of ILinqEnumerable.select

Overwrites InfiniteEnumerable.select
- Defined in source/System.Linq/Linq.ts:2658
Type parameters
- TResult
Parameters
- selector: Selector<T, TResult>
Returns Enumerable<TResult>

selectMany

selectMany<TResult>(collectionSelector: Selector<T, IEnumerableOrArray>): Enumerable<TResult>
selectMany<TElement, TResult>(collectionSelector: Selector<T, IEnumerableOrArray>, resultSelector: function): Enumerable<TResult>

Implementation of ILinqEnumerable.selectMany

Overwrites InfiniteEnumerable.selectMany
- Defined in source/System.Linq/Linq.ts:2663
Type parameters
- TResult
Parameters
- collectionSelector: Selector<T, IEnumerableOrArray>
Returns Enumerable<TResult>
Overwrites InfiniteEnumerable.selectMany
- Defined in source/System.Linq/Linq.ts:2667
Type parameters
- TElement
- TResult
Parameters
- collectionSelector: Selector<T, IEnumerableOrArray>
- resultSelector: function
  - - (collection: T, element: TElement): TResult
    - Parameters
      - collection: T
      - element: TElement
      Returns TResult
Returns Enumerable<TResult>

sequenceEqual

sequenceEqual(second: IEnumerableOrArray, equalityComparer?: EqualityComparison<T>): boolean

Implementation of ILinqEnumerable.sequenceEqual
- Defined in source/System.Linq/Linq.ts:2958
Parameters
- second: IEnumerableOrArray
- Default value equalityComparer: EqualityComparison<T> = Values.areEqual
Returns boolean

share()

Implementation of ILinqEnumerable.share

Inherited from InfiniteEnumerable.share
- Defined in source/System.Linq/Linq.ts:1794

shuffle

shuffle()

Implementation of ILinqEnumerable.shuffle
- Defined in source/System.Linq/Linq.ts:2720

single

single(): T

Implementation of ILinqEnumerable.single

Inherited from InfiniteEnumerable.single
- Defined in source/System.Linq/Linq.ts:323
Returns T

singleOrDefault

singleOrDefault(defaultValue?: T): T

Implementation of ILinqEnumerable.singleOrDefault

Inherited from InfiniteEnumerable.singleOrDefault
- Defined in source/System.Linq/Linq.ts:343
Parameters
- Default value defaultValue: T = null
Returns T

skip

skip(count: number)

Implementation of ILinqEnumerable.skip

Inherited from InfiniteEnumerable.skip
- Defined in source/System.Linq/Linq.ts:227
Parameters
- count: number

skipToLast

skipToLast(count: number)

Implementation of ILinqEnumerable.skipToLast
- Defined in source/System.Linq/Linq.ts:2638
Parameters
- count: number

skipWhile

skipWhile(predicate: Predicate<T>)

Implementation of ILinqEnumerable.skipWhile
- Defined in source/System.Linq/Linq.ts:2426
Parameters
- predicate: Predicate<T>

some

some(predicate: Predicate<T>): boolean

Implementation of ILinqEnumerable.some
- Defined in source/System.Linq/Linq.ts:2838
Parameters
- predicate: Predicate<T>
Returns boolean

sum

sum(selector?: Selector<T, number>): number

Implementation of ILinqEnumerable.sum
- Defined in source/System.Linq/Linq.ts:3230
Parameters
- Default value selector: Selector<T, number> = Type.numberOrNaN
Returns number

take

take(count: number): FiniteEnumerable<T>

Implementation of ILinqEnumerable.take

Inherited from InfiniteEnumerable.take
- Defined in source/System.Linq/Linq.ts:246
Parameters
- count: number
Returns FiniteEnumerable<T>

takeExceptLast

takeExceptLast(count?: number)

Implementation of ILinqEnumerable.takeExceptLast
- Defined in source/System.Linq/Linq.ts:2588
Parameters
- Default value count: number = 1

takeUntil

takeUntil(predicate: Predicate<T>, includeUntilValue?: boolean)

Implementation of ILinqEnumerable.takeUntil
- Defined in source/System.Linq/Linq.ts:2455
Parameters
- predicate: Predicate<T>
- Optional includeUntilValue: boolean

takeWhile

takeWhile(predicate: Predicate<T>)

Implementation of ILinqEnumerable.takeWhile
- Defined in source/System.Linq/Linq.ts:2437
Parameters
- predicate: Predicate<T>

Protected throwIfDisposed

throwIfDisposed(message?: string, objectName?: string): boolean

Inherited from DisposableBase.throwIfDisposed
- Defined in source/System/Disposable/DisposableBase.ts:26
Parameters
- Optional message: string
- Default value objectName: string = this._disposableObjectName
Returns boolean

toArray

toArray(predicate?: Predicate<T>): T[]

Implementation of ILinqEnumerable.toArray
- Defined in source/System.Linq/Linq.ts:2516
Parameters
- Optional predicate: Predicate<T>
Returns T[]

toDictionary

toDictionary<TKey, TValue, TCompare>(keySelector: Selector<T, TKey>, elementSelector: Selector<T, TValue>, compareSelector?: Selector<TKey, TCompare>): IDictionary<TKey, TValue>

Implementation of ILinqEnumerable.toDictionary
- Defined in source/System.Linq/Linq.ts:2570
Type parameters
- TKey
- TValue
- TCompare
Parameters
- keySelector: Selector<T, TKey>
- elementSelector: Selector<T, TValue>
- Default value compareSelector: Selector<TKey, TCompare> = Functions.Identity
Returns IDictionary<TKey, TValue>

toJoinedString

toJoinedString(separator?: string, selector?: Selector<T, string>): string

Implementation of ILinqEnumerable.toJoinedString
- Defined in source/System.Linq/Linq.ts:2580
Parameters
- Default value separator: string = ""
- Default value selector: Selector<T, string> = Functions.Identity
Returns string

toLookup

toLookup<TKey, TValue, TCompare>(keySelector: Selector<T, TKey>, elementSelector?: Selector<T, TValue>, compareSelector?: Selector<TKey, TCompare>): ILookup<TKey, TValue>

Implementation of ILinqEnumerable.toLookup
- Defined in source/System.Linq/Linq.ts:2538
Type parameters
- TKey
- TValue
- TCompare
Parameters
- keySelector: Selector<T, TKey>
- Default value elementSelector: Selector<T, TValue> = Functions.Identity
- Default value compareSelector: Selector<TKey, TCompare> = Functions.Identity
Returns ILookup<TKey, TValue>

toMap

toMap<TResult>(keySelector: Selector<T, string>, elementSelector: Selector<T, TResult>): IMap<TResult>

Implementation of ILinqEnumerable.toMap
- Defined in source/System.Linq/Linq.ts:2558
Type parameters
- TResult
Parameters
- keySelector: Selector<T, string>
- elementSelector: Selector<T, TResult>
Returns IMap<TResult>

traverseBreadthFirst

traverseBreadthFirst(childrenSelector: function): Enumerable<T>
traverseBreadthFirst<TNode>(childrenSelector: function): Enumerable<TNode>
traverseBreadthFirst<TResult>(childrenSelector: function, resultSelector?: function): Enumerable<TResult>
traverseBreadthFirst<TNode, TResult>(childrenSelector: function, resultSelector?: function): Enumerable<TResult>

Inherited from InfiniteEnumerable.traverseBreadthFirst
- Defined in source/System.Linq/Linq.ts:384
Parameters
- childrenSelector: function
  - - (element: T): IEnumerableOrArray
    - Parameters
      - element: T
      Returns IEnumerableOrArray
Returns Enumerable<T>
Inherited from InfiniteEnumerable.traverseBreadthFirst
- Defined in source/System.Linq/Linq.ts:387
Type parameters
- TNode
Parameters
- childrenSelector: function
  - - (element: T | TNode): IEnumerableOrArray
    - Parameters
      - element: T | TNode
      Returns IEnumerableOrArray
Returns Enumerable<TNode>
Inherited from InfiniteEnumerable.traverseBreadthFirst
- Defined in source/System.Linq/Linq.ts:390
Type parameters
- TResult
Parameters
- childrenSelector: function
  - - (element: T): IEnumerableOrArray
    - Parameters
      - element: T
      Returns IEnumerableOrArray
- Optional resultSelector: function
  - - (element: T, nestLevel?: number): TResult
    - Parameters
      - element: T
      - Optional nestLevel: number
      Returns TResult
Returns Enumerable<TResult>
Inherited from InfiniteEnumerable.traverseBreadthFirst
- Defined in source/System.Linq/Linq.ts:394
Type parameters
- TNode
- TResult
Parameters
- childrenSelector: function
  - - (element: T | TNode): IEnumerableOrArray
    - Parameters
      - element: T | TNode
      Returns IEnumerableOrArray
- Optional resultSelector: function
  - - (element: TNode, nestLevel?: number): TResult
    - Parameters
      - element: TNode
      - Optional nestLevel: number
      Returns TResult
Returns Enumerable<TResult>

traverseDepthFirst

traverseDepthFirst(childrenSelector: function): Enumerable<T>
traverseDepthFirst<TNode>(childrenSelector: function): Enumerable<TNode>
traverseDepthFirst<TResult>(childrenSelector: function, resultSelector?: function): Enumerable<TResult>
traverseDepthFirst<TNode, TResult>(childrenSelector: function, resultSelector?: function): Enumerable<TResult>

Inherited from InfiniteEnumerable.traverseDepthFirst
- Defined in source/System.Linq/Linq.ts:471
Parameters
- childrenSelector: function
  - - (element: T): IEnumerableOrArray
    - Parameters
      - element: T
      Returns IEnumerableOrArray
Returns Enumerable<T>
Inherited from InfiniteEnumerable.traverseDepthFirst
- Defined in source/System.Linq/Linq.ts:474
Type parameters
- TNode
Parameters
- childrenSelector: function
  - - (element: T | TNode): IEnumerableOrArray
    - Parameters
      - element: T | TNode
      Returns IEnumerableOrArray
Returns Enumerable<TNode>
Inherited from InfiniteEnumerable.traverseDepthFirst
- Defined in source/System.Linq/Linq.ts:477
Type parameters
- TResult
Parameters
- childrenSelector: function
  - - (element: T): IEnumerableOrArray
    - Parameters
      - element: T
      Returns IEnumerableOrArray
- Optional resultSelector: function
  - - (element: T, nestLevel?: number): TResult
    - Parameters
      - element: T
      - Optional nestLevel: number
      Returns TResult
Returns Enumerable<TResult>
Inherited from InfiniteEnumerable.traverseDepthFirst
- Defined in source/System.Linq/Linq.ts:481
Type parameters
- TNode
- TResult
Parameters
- childrenSelector: function
  - - (element: T | TNode): IEnumerableOrArray
    - Parameters
      - element: T | TNode
      Returns IEnumerableOrArray
- Optional resultSelector: function
  - - (element: TNode, nestLevel?: number): TResult
    - Parameters
      - element: TNode
      - Optional nestLevel: number
      Returns TResult
Returns Enumerable<TResult>

union

union<TCompare>(second: IEnumerableOrArray, compareSelector?: Selector<T, TCompare>)

Implementation of ILinqEnumerable.union

Inherited from InfiniteEnumerable.union
- Defined in source/System.Linq/Linq.ts:1448
Type parameters
- TCompare
Parameters
- second: IEnumerableOrArray
- Default value compareSelector: Selector<T, TCompare> = Functions.Identity

where

where(predicate: Predicate<T>)

Implementation of ILinqEnumerable.where

Inherited from InfiniteEnumerable.where
- Defined in source/System.Linq/Linq.ts:921
Parameters
- predicate: Predicate<T>

zip

zip<TSecond, TResult>(second: IEnumerableOrArray, resultSelector: function): Enumerable<TResult>

Inherited from InfiniteEnumerable.zip
- Defined in source/System.Linq/Linq.ts:1175
Type parameters
- TSecond
- TResult
Parameters
- second: IEnumerableOrArray
- resultSelector: function
  - - (first: T, second: TSecond, index?: number): TResult
    - Parameters
      - first: T
      - second: TSecond
      - Optional index: number
      Returns TResult
Returns Enumerable<TResult>

zipMultiple

zipMultiple<TSecond, TResult>(second: IArray, resultSelector: function): Enumerable<TResult>

Inherited from InfiniteEnumerable.zipMultiple
- Defined in source/System.Linq/Linq.ts:1212
Type parameters
- TSecond
- TResult
Parameters
- second: IArray
- resultSelector: function
  - - (first: T, second: TSecond, index?: number): TResult
    - Parameters
      - first: T
      - second: TSecond
      - Optional index: number
      Returns TResult
Returns Enumerable<TResult>

Static choice

choice<T>(values: IArray): InfiniteEnumerable<T>

- Defined in source/System.Linq/Linq.ts:1903
Type parameters
- T
Parameters
- values: IArray
Returns InfiniteEnumerable<T>

Static chooseFrom

chooseFrom<T>(...args: T[]): InfiniteEnumerable<T>

- Defined in source/System.Linq/Linq.ts:1921
Type parameters
- T
Parameters
- Rest ...args: T[]
Returns InfiniteEnumerable<T>

Static cycle

cycle<T>(values: IArray): InfiniteEnumerable<T>

- Defined in source/System.Linq/Linq.ts:1926
Type parameters
- T
Parameters
- values: IArray
Returns InfiniteEnumerable<T>

Static cycleThrough

cycleThrough<T>(...args: T[]): InfiniteEnumerable<T>

- Defined in source/System.Linq/Linq.ts:1954
Type parameters
- T
Parameters
- Rest ...args: T[]
Returns InfiniteEnumerable<T>

Static empty

empty<T>(): FiniteEnumerable<T>

- Defined in source/System.Linq/Linq.ts:1959
Type parameters
- T
Returns FiniteEnumerable<T>

Static forEach

forEach<T>(enumerable: IEnumerableOrArray, action: function, max?: number): number

- Defined in source/System.Linq/Linq.ts:2312
Type parameters
- T
Parameters
- enumerable: IEnumerableOrArray
- action: function
  - - (element: T, index?: number): any
    - Parameters
      - element: T
      - Optional index: number
      Returns any
- Default value max: number = Infinity
Returns number

Static from

from<T>(source: IEnumerableOrArray): Enumerable<T>

- Defined in source/System.Linq/Linq.ts:1843
Universal method for converting a primitive enumerables into a LINQ enabled ones.

Is not limited to TypeScript usages.

Type parameters
- T
Parameters
- source: IEnumerableOrArray
Returns Enumerable<T>

Static fromAny

fromAny(source: any): Enumerable<any>
fromAny<T>(source: IEnumerableOrArray, defaultEnumerable?: Enumerable<T>): Enumerable<T>
fromAny<T>(source: any, defaultEnumerable?: Enumerable<T>): Enumerable<T>

- Defined in source/System.Linq/Linq.ts:1850
Parameters
- source: any
Returns Enumerable<any>
- Defined in source/System.Linq/Linq.ts:1853
Type parameters
- T
Parameters
- source: IEnumerableOrArray
- Optional defaultEnumerable: Enumerable<T>
Returns Enumerable<T>
- Defined in source/System.Linq/Linq.ts:1857
Type parameters
- T
Parameters
- source: any
- Optional defaultEnumerable: Enumerable<T>
Returns Enumerable<T>

Static fromOrEmpty

fromOrEmpty<T>(source: IEnumerableOrArray): Enumerable<T>

- Defined in source/System.Linq/Linq.ts:1882
Type parameters
- T
Parameters
- source: IEnumerableOrArray
Returns Enumerable<T>

Static generate

generate<T>(factory: function): InfiniteEnumerable<T>
generate<T>(factory: function, count: number): FiniteEnumerable<T>

- Defined in source/System.Linq/Linq.ts:2228
Type parameters
- T
Parameters
- factory: function
  - - (index?: number): T
    - Parameters
      - Optional index: number
      Returns T
Returns InfiniteEnumerable<T>
- Defined in source/System.Linq/Linq.ts:2229
Type parameters
- T
Parameters
- factory: function
  - - (index?: number): T
    - Parameters
      - Optional index: number
      Returns T
- count: number
Returns FiniteEnumerable<T>

Static make

make<T>(element: T): FiniteEnumerable<T>

- Defined in source/System.Linq/Linq.ts:2032
Creates an enumerable of one element.

Type parameters
- T
Parameters
- element: T
Returns FiniteEnumerable<T>

Static map

map<T, TResult>(enumerable: IEnumerableOrArray, selector: Selector<T, TResult>): TResult[]

- Defined in source/System.Linq/Linq.ts:2322
Type parameters
- T
- TResult
Parameters
- enumerable: IEnumerableOrArray
- selector: Selector<T, TResult>
Returns TResult[]

Static matches

matches(input: string, pattern: any, flags?: string): FiniteEnumerable<RegExpExecArray>

- Defined in source/System.Linq/Linq.ts:2190
Parameters
- input: string
- pattern: any
- Default value flags: string = ""
Returns FiniteEnumerable<RegExpExecArray>

Static max

max(values: FiniteEnumerable<number>): number

- Defined in source/System.Linq/Linq.ts:2333
Parameters
- values: FiniteEnumerable<number>
Returns number

Static min

min(values: FiniteEnumerable<number>): number

- Defined in source/System.Linq/Linq.ts:2340
Parameters
- values: FiniteEnumerable<number>
Returns number

Static range

range(start: number, count: number, step?: number): FiniteEnumerable<number>

- Defined in source/System.Linq/Linq.ts:2039
Parameters
- start: number
- count: number
- Default value step: number = 1
Returns FiniteEnumerable<number>

Static rangeDown

rangeDown(start: number, count: number, step?: number): FiniteEnumerable<number>

- Defined in source/System.Linq/Linq.ts:2089
Parameters
- start: number
- count: number
- Default value step: number = 1
Returns FiniteEnumerable<number>

Static rangeTo

rangeTo(start: number, to: number, step?: number): FiniteEnumerable<number>

- Defined in source/System.Linq/Linq.ts:2144
Parameters
- start: number
- to: number
- Default value step: number = 1
Returns FiniteEnumerable<number>

Static repeat

repeat<T>(element: T): InfiniteEnumerable<T>
repeat<T>(element: T, count: number): FiniteEnumerable<T>

- Defined in source/System.Linq/Linq.ts:1965
Type parameters
- T
Parameters
- element: T
Returns InfiniteEnumerable<T>
- Defined in source/System.Linq/Linq.ts:1966
Type parameters
- T
Parameters
- element: T
- count: number
Returns FiniteEnumerable<T>

Static repeatWithFinalize

repeatWithFinalize<T>(initializer: function, finalizer: function): InfiniteEnumerable<T>

- Defined in source/System.Linq/Linq.ts:1998
Type parameters
- T
Parameters
- initializer: function
  - - (): T
    - Returns T
- finalizer: function
  - - (element: T): void
    - Parameters
      - element: T
      Returns void
Returns InfiniteEnumerable<T>

Static toArray

toArray<T>(source: IEnumerableOrArray): T[]

- Defined in source/System.Linq/Linq.ts:1892
Static helper for converting enumerables to an array.

Type parameters
- T
Parameters
- source: IEnumerableOrArray
Returns T[]

Static toInfinity

toInfinity(start?: number, step?: number): InfiniteEnumerable<number>

- Defined in source/System.Linq/Linq.ts:2100
Parameters
- Default value start: number = 0
- Default value step: number = 1
Returns InfiniteEnumerable<number>

Static toNegativeInfinity

toNegativeInfinity(start?: number, step?: number): InfiniteEnumerable<number>

- Defined in source/System.Linq/Linq.ts:2137
Parameters
- Default value start: number = 0
- Default value step: number = 1
Returns InfiniteEnumerable<number>

Static unfold

unfold<T>(seed: T, valueFactory: Selector<T, T>, skipSeed?: Boolean): InfiniteEnumerable<T>

- Defined in source/System.Linq/Linq.ts:2277
Type parameters
- T
Parameters
- seed: T
- valueFactory: Selector<T, T>
- Default value skipSeed: Boolean = false
Returns InfiniteEnumerable<T>

Static weave

weave<T>(enumerables: IEnumerableOrArray): Enumerable<T>

- Defined in source/System.Linq/Linq.ts:2353
Takes any set of collections of the same type and weaves them together.

Type parameters
- T
Parameters
- enumerables: IEnumerableOrArray
Returns Enumerable<T>

Type parameters

T

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

enumeratorFactory: function

Returns IEnumerator<T>

Optional finalizer: function

Returns void

Default value isEndless: boolean = null

Returns Enumerable

Properties

Protected _disposableObjectName

Protected _enumeratorFactory

Type declaration

Returns IEnumerator<T>

Protected _isEndless

Accessors

isEndless

Returns boolean

wasDisposed

Returns boolean

Methods

Protected _choose

Type parameters

TResult

Parameters

selector: Selector<T, TResult>

Returns Enumerable<TResult>

Protected _onDispose

Returns void

Protected _selectMany

Type parameters

TElement

TResult

Parameters

collectionSelector: Selector<T, IEnumerableOrArray>

Optional resultSelector: function

Parameters

collection: T

element: TElement

Returns TResult

Returns Enumerable<TResult>

aggregate

Parameters

func: function

Parameters

a: T

b: T

Returns T

Optional seed: T

Returns T

all

Parameters

predicate: Predicate<T>

Returns boolean

alternate

Parameters

Rest ...sequence: T[]

alternateMultiple

Parameters

sequence: IEnumerableOrArray

alternateSingle

Parameters

value: T

any

Parameters

Optional predicate: Predicate<T>

Returns boolean

asEnumerable

average

Parameters

Default value selector: Selector<T, number> = Type.numberOrNaN