Class EnumerableBase<T>`Abstract`

Type Parameters

Hierarchy

EnumerableBase

Implements

IEnumerable<T>

Constructors

constructor

new EnumerableBase<T>(): EnumerableBase<T>
Type Parameters
- T
Returns EnumerableBase<T>

Methods

[iterator]

[iterator](): Iterator<T, any, undefined>
Returns Iterator<T, any, undefined>
Implementation of IEnumerable.[iterator]
- Defined in src/Enumerables/index.ts:90

all

all(predicate): boolean
Returns true if all the items match the predicate, otherwise false
Parameters
- predicate: Predicate<T>
Returns boolean
Implementation of IEnumerable.all
- Defined in src/Enumerables/index.ts:127

any

any(predicate?): boolean

Returns true if any of the items match the predicate, otherwise false

Parameters

Optional predicate: Predicate<T>

Returns boolean

Example

if (myEnumerable.any()) {
    // do something because the enumerable has elements
}

let myEnumerable = new ArrayEnumerable([1, 2, 3, 4]);
if (myEnumerable.any((i) => i == 2)) {
    // the enumerable contains a '2'
}

append

append(item): IEnumerable<T>
Adds a value to the end of the sequence.
Parameters
- item: T
Returns IEnumerable<T>
Implementation of IEnumerable.append
- Defined in src/Enumerables/index.ts:97

average

average(selector): number
Returns the average of the numbers selected by the selector
Parameters
- selector: Selector<T, number>
Returns number
Implementation of IEnumerable.average
- Defined in src/Enumerables/index.ts:137

concat

concat(next): IEnumerable<T>
Concatenates two sequences.
Parameters
- next: IEnumerable<T>
Returns IEnumerable<T>
Implementation of IEnumerable.concat
- Defined in src/Enumerables/index.ts:102

contains

contains(item): boolean
Determines whether a sequence contains a specified element.
Parameters
- item: T
  The value to locate in the sequence.
Returns boolean
Implementation of IEnumerable.contains
- Defined in src/Enumerables/index.ts:112

count

count(): number
Returns the number of items in the enumerable

Returns number
Implementation of IEnumerable.count
- Defined in src/Enumerables/index.ts:142

distinct

distinct<R>(selector): IEnumerable<T>
Returns the unique items designated by the selector
Type Parameters
- R
Parameters
- selector: ((a) => R)
  - - (a): R
    - Parameters
      a: T
      Returns R
Returns IEnumerable<T>
Implementation of IEnumerable.distinct
- Defined in src/Enumerables/index.ts:148

first

first(predicate?): T
Returns the first item in the enumerable
Parameters
- Optional predicate: Predicate<T>
Returns T
Implementation of IEnumerable.first
- Defined in src/Enumerables/index.ts:153

firstOrDefault

firstOrDefault(predicate?): null | T
Returns the first item in the enumerable or null
Parameters
- Optional predicate: Predicate<T>
Returns null | T
Implementation of IEnumerable.firstOrDefault
- Defined in src/Enumerables/index.ts:158

forEach

forEach(callback): void
Iterates over the enumerable and performs the callback on each item. Return false to break.
Parameters
- callback: ((value, index) => boolean | void)
  - - (value, index): boolean | void
    - Parameters
      value: T
      index: number
      Returns boolean | void
Returns void
Implementation of IEnumerable.forEach
- Defined in src/Enumerables/index.ts:117

`Abstract` getEnumerator

getEnumerator(): IEnumerator<T>
returns an Enumerator for the items

Returns IEnumerator<T>
Implementation of IEnumerable.getEnumerator
- Defined in src/Enumerables/index.ts:95

groupBy

groupBy<TKey>(selector, comparer?): IEnumerable<IEnumerableGroup<T, TKey>>
Groups the items by the key selector using the default comparer
Type Parameters
- TKey
Parameters
- selector: Selector<T, TKey>
- comparer: IComparer<TKey> = DefaultComparers.DefaultComparer
Returns IEnumerable<IEnumerableGroup<T, TKey>>
Implementation of IEnumerable.groupBy
- Defined in src/Enumerables/index.ts:163

`Private` internalOrderBy

internalOrderBy<R>(selector, comparer): IEnumerable<T>
Type Parameters
- R
Parameters
- selector: ((a) => R)
  - - (a): R
    - Parameters
      a: T
      Returns R
- comparer: IComparer<R>
Returns IEnumerable<T>
- Defined in src/Enumerables/index.ts:296

item

item(index): Undefinable<T>
Returns the item at the specified index
Parameters
- index: number
  The index of the item to return
Returns Undefinable<T>
Implementation of IEnumerable.item
- Defined in src/Enumerables/index.ts:122

last

last(predicate?): T
Returns the last item in the enumerable
Parameters
- Optional predicate: Predicate<T>
Returns T
Implementation of IEnumerable.last
- Defined in src/Enumerables/index.ts:193

lastOrDefault

lastOrDefault(predicate?): null | T
Returns the last item in the enumerable or null
Parameters
- Optional predicate: Predicate<T>
Returns null | T
Implementation of IEnumerable.lastOrDefault
- Defined in src/Enumerables/index.ts:198

max

max(selector): number
Returns the largest number designated by the selector
Parameters
- selector: Selector<T, number>
Returns number
Implementation of IEnumerable.max
- Defined in src/Enumerables/index.ts:203

min

min(selector): number
Returns the smallest number designated by the selector
Parameters
- selector: Selector<T, number>
Returns number
Implementation of IEnumerable.min
- Defined in src/Enumerables/index.ts:208

ofType

ofType<N>(ctor): IEnumerable<N>
Returns an enumerable of items that match the type
Type Parameters
- N
Parameters
- ctor: ConstructorFor<N>
  the type
Returns IEnumerable<N>
Implementation of IEnumerable.ofType
- Defined in src/Enumerables/index.ts:213

orderBy

orderBy<R>(selector, comparer?): IEnumerable<T>
Orders the enumerable by the the selector and optional comparer ascending
Type Parameters
- R
Parameters
- selector: ((a) => R)
  - - (a): R
    - Parameters
      a: T
      Returns R
- Optional comparer: IComparer<R>
Returns IEnumerable<T>
Implementation of IEnumerable.orderBy
- Defined in src/Enumerables/index.ts:218

orderByDescending

orderByDescending<R>(selector, comparer?): IEnumerable<T>
Orders the enumerable by the the selector and optional comparer descending
Type Parameters
- R
Parameters
- selector: ((a) => R)
  - - (a): R
    - Parameters
      a: T
      Returns R
- Optional comparer: IComparer<R>
Returns IEnumerable<T>
Implementation of IEnumerable.orderByDescending
- Defined in src/Enumerables/index.ts:223

prepend

prepend(item): IEnumerable<T>
Adds a value to the beginning of the sequence.
Parameters
- item: T
Returns IEnumerable<T>
Implementation of IEnumerable.prepend
- Defined in src/Enumerables/index.ts:107

select

select<TOut>(selector): IEnumerable<TOut>
Selects the items by the selector
Type Parameters
- TOut
Parameters
- selector: Selector<T, TOut>
Returns IEnumerable<TOut>
Implementation of IEnumerable.select
- Defined in src/Enumerables/index.ts:228

selectMany

selectMany<TOut>(selector): IEnumerable<TOut>
Type Parameters
- TOut
Parameters
- selector: Selector<T, IEnumerable<TOut>>
Returns IEnumerable<TOut>
Implementation of IEnumerable.selectMany
- Defined in src/Enumerables/index.ts:233

single

single(predicate?): T
Returns a single element only if there is one element in the enumerable
Parameters
- Optional predicate: Predicate<T>
Returns T
Throws
InvalidOperationException if there is not exactly one item in the enumerable
Implementation of IEnumerable.single
- Defined in src/Enumerables/index.ts:238

singleOrDefault

singleOrDefault(predicate?): null | T
Returns a single element only if there is one element in the enumerable. If there are no items in the enumerable, then null is returned
Parameters
- Optional predicate: Predicate<T>
Returns null | T
Throws
InvalidOperationException if there is not exactly one or zero items in the enumerable
Implementation of IEnumerable.singleOrDefault
- Defined in src/Enumerables/index.ts:243

skip

skip(count): IEnumerable<T>
Skips the number of items specified. If the count is larger than the size of the enumerable, no items will be returned.
Parameters
- count: number
  the number of items to skip
Returns IEnumerable<T>
Implementation of IEnumerable.skip
- Defined in src/Enumerables/index.ts:248

split

split(predicate): {
pFalse: IEnumerable<T>;
pTrue: IEnumerable<T>;
}
Splits a enumerable into two queryables. One set is for true predicates, the other set is for false predicates.
Parameters
- predicate: Predicate<T>
Returns {
pFalse: IEnumerable<T>;
pTrue: IEnumerable<T>;
}
- pFalse: IEnumerable<T>
- pTrue: IEnumerable<T>
Implementation of IEnumerable.split
- Defined in src/Enumerables/index.ts:253

sum

sum(selector): number
Sums the items in the enumerable using the selector
Parameters
- selector: Selector<T, number>
  selector to return the number to be summed
Returns number
Implementation of IEnumerable.sum
- Defined in src/Enumerables/index.ts:261

take

take(count): IEnumerable<T>
Takes the number of specified items from the enumerable. If the count is larger than the size of the enumerable, all items will be returned
Parameters
- count: number
  the number of items to take.
Returns IEnumerable<T>
Implementation of IEnumerable.take
- Defined in src/Enumerables/index.ts:266

toArray

toArray(): T[]
Returns the items as an array

Returns T[]
Implementation of IEnumerable.toArray
- Defined in src/Enumerables/index.ts:276

toDictionary

toDictionary<TKey, TValue>(keySelector, valueSelector): IDictionary<TKey, TValue>
Returns a dictionary based on the key and value selctors
Type Parameters
- TKey
- TValue
Parameters
- keySelector: ((a) => TKey)
  - - (a): TKey
    - Parameters
      a: T
      Returns TKey
- valueSelector: ((a) => TValue)
  - - (a): TValue
    - Parameters
      a: T
      Returns TValue
Returns IDictionary<TKey, TValue>
Implementation of IEnumerable.toDictionary
- Defined in src/Enumerables/index.ts:281

toList

toList(): IList<T>
Returns the items as a List

Returns IList<T>
Implementation of IEnumerable.toList
- Defined in src/Enumerables/index.ts:291

where

where(predicate): IEnumerable<T>
Filters the enumerable by the predicate
Parameters
- predicate: Predicate<T>
  the filter for each item.
Returns IEnumerable<T>
Implementation of IEnumerable.where
- Defined in src/Enumerables/index.ts:271

Class EnumerableBase<T>Abstract

Type Parameters

T

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Type Parameters

T

Returns EnumerableBase<T>

Methods

[iterator]

Returns Iterator<T, any, undefined>

all

Parameters

predicate: Predicate<T>

Returns boolean

any

Parameters

Optional predicate: Predicate<T>

Returns boolean

Example

append

Parameters

item: T

Returns IEnumerable<T>

average

Parameters

selector: Selector<T, number>

Returns number

concat

Parameters

next: IEnumerable<T>

Returns IEnumerable<T>

contains

Parameters

item: T

Returns boolean

count

Returns number

distinct

Type Parameters

R

Parameters

selector: ((a) => R)

Parameters

a: T

Returns R

Returns IEnumerable<T>

first

Parameters

Optional predicate: Predicate<T>

Returns T

firstOrDefault

Parameters

Optional predicate: Predicate<T>

Returns null | T

forEach

Parameters

callback: ((value, index) => boolean | void)

Parameters

value: T

index: number

Returns boolean | void

Returns void

Abstract getEnumerator

Returns IEnumerator<T>

groupBy

Type Parameters

TKey

Parameters

selector: Selector<T, TKey>

comparer: IComparer<TKey> = DefaultComparers.DefaultComparer

Returns IEnumerable<IEnumerableGroup<T, TKey>>

Private internalOrderBy

Type Parameters

R

Class EnumerableBase<T>`Abstract`

`Optional` predicate: Predicate<T>

`Optional` predicate: Predicate<T>

`Optional` predicate: Predicate<T>

`Abstract` getEnumerator

`Private` internalOrderBy

`Optional` predicate: Predicate<T>

`Optional` predicate: Predicate<T>

`Optional` comparer: IComparer<R>

`Optional` comparer: IComparer<R>