Class ExtendedIterable<T>

Extends an iterable with methods like filter, map, and reduce.

Type Parameters

Hierarchy (View Summary)

ReadOnlyIterableCollectionBase<T>
- ExtendedIterable

Index

Constructors

constructor

Methods

[iterator] copyTo filter getCount map reduce toArray create

Constructors

`Protected`constructor

new ExtendedIterable<T>(_source: Iterable<T>): ExtendedIterable<T>
Type Parameters
- T
Parameters
- _source: Iterable<T>
Returns ExtendedIterable<T>
Overrides ReadOnlyIterableCollectionBase.constructor
- Defined in ReadOnlyIterableCollectionBase.ts:145

Methods

[iterator]

"[iterator]"(): Iterator<T>
Returns Iterator<T>
Inherited from ReadOnlyIterableCollectionBase.[iterator]
- Defined in IterableBase.ts:24

copyTo

copyTo<TTarget extends ArrayLikeWritable<T>>(
target: TTarget,
index?: number,
): TTarget
Copies all values to a numerically indexable object.
Type Parameters
- TTarget extends ArrayLikeWritable<T>
Parameters
- target: TTarget
- index: number = 0
Returns TTarget
Inherited from ReadOnlyIterableCollectionBase.copyTo
- Defined in ReadOnlyIterableCollectionBase.ts:112

filter

filter(predicate: PredicateWithIndex<T>): ExtendedIterable<T>
Returns an iterable filtered by the provided predicate.
Parameters
- predicate: PredicateWithIndex<T>
Returns ExtendedIterable<T>
Inherited from ReadOnlyIterableCollectionBase.filter
- Defined in ReadOnlyIterableCollectionBase.ts:32

getCount

getCount(): number
Returns the number of items contained in the collection by iterating the contents.

Returns number
Inherited from ReadOnlyIterableCollectionBase.getCount
- Defined in ReadOnlyIterableCollectionBase.ts:130

map

map<TResult>(selector: SelectorWithIndex<T, TResult>): ExtendedIterable<TResult>
Returns an iterable mapped by the provided selector.
Type Parameters
- TResult
Parameters
- selector: SelectorWithIndex<T, TResult>
Returns ExtendedIterable<TResult>
Inherited from ReadOnlyIterableCollectionBase.map
- Defined in ReadOnlyIterableCollectionBase.ts:50

reduce

reduce<T>(reduction: (previous: T, current: T, index: number) => T): T
Applies a reducer function to all the elements in this sequence. The first entry is used as the initial accumulator value, and the specified function is used to select the result value.
Type Parameters
- T
Parameters
- reduction: (previous: T, current: T, index: number) => T
Returns T
Throws
If the sequence is empty.
Inherited from ReadOnlyIterableCollectionBase.reduce
- Defined in ReadOnlyIterableCollectionBase.ts:64
reduce<T, U>(
reduction: (previous: U, current: T, index: number) => U,
initialValue: U,
): U
Applies a reducer function to all the elements in this sequence. The specified seed value is used as the initial accumulator value, and the specified function is used to select the result value.
Type Parameters
- T
- U
Parameters
- reduction: (previous: U, current: T, index: number) => U
- initialValue: U
Returns U
Inherited from ReadOnlyIterableCollectionBase.reduce
- Defined in ReadOnlyIterableCollectionBase.ts:73

toArray

toArray(): T[]
Creates a copy of the contents as an array.

Returns T[]
Inherited from ReadOnlyIterableCollectionBase.toArray
- Defined in ReadOnlyIterableCollectionBase.ts:121

`Static`create

create<T>(source: Iterable<T>): ExtendedIterable<T>
Creates an ExtendedIterable wrapper for the provided source.
Type Parameters
- T
Parameters
- source: Iterable<T>
Returns ExtendedIterable<T>
- Defined in ReadOnlyIterableCollectionBase.ts:155

Class ExtendedIterable<T>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

Protectedconstructor

Type Parameters

Parameters

Returns ExtendedIterable<T>

Methods

[iterator]

Returns Iterator<T>

copyTo

Type Parameters

Parameters

Returns TTarget

filter

Parameters

Returns ExtendedIterable<T>

getCount

Returns number

map

Type Parameters

Parameters

Returns ExtendedIterable<TResult>

reduce

Type Parameters

Parameters

Returns T

Throws

Type Parameters

Parameters

Returns U

toArray

Returns T[]

Staticcreate

Type Parameters

Parameters

Returns ExtendedIterable<T>

Settings

On This Page

`Protected`constructor

`Static`create