Class ExtendedIterable<T>

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

Type Parameters

Hierarchy

ReadOnlyIterableCollectionBase<T>
- ExtendedIterable

Index

Constructors

constructor

Methods

[iterator] _getIterator 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:147

Methods

[iterator]

[iterator](): Iterator<T, any, undefined>
Returns Iterator<T, any, undefined>
Inherited from ReadOnlyIterableCollectionBase.[iterator]
- Defined in IterableBase.ts:25

`Protected` _getIterator

_getIterator(): Iterator<T, any, undefined>
Returns Iterator<T, any, undefined>
Overrides ReadOnlyIterableCollectionBase._getIterator
- Defined in ReadOnlyIterableCollectionBase.ts:162

copyTo

copyTo<TTarget>(target: TTarget, index?: number): TTarget
Copies all values to a numerically indexable object.

Returns
Type Parameters
- TTarget extends ArrayLikeWritable<T, TTarget>
Parameters
- target: TTarget
- index: number = 0
Returns TTarget
Inherited from ReadOnlyIterableCollectionBase.copyTo
- Defined in ReadOnlyIterableCollectionBase.ts:114

filter

filter(predicate: PredicateWithIndex<T>): ExtendedIterable<T>
Returns an iterable filtered by the provided predicate.

Returns
Parameters
- predicate: PredicateWithIndex<T>
Returns ExtendedIterable<T>
Inherited from ReadOnlyIterableCollectionBase.filter
- Defined in ReadOnlyIterableCollectionBase.ts:34

getCount

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

Returns

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

map

map<TResult>(selector: SelectorWithIndex<T, TResult>): ExtendedIterable<TResult>
Returns an iterable mapped by the provided selector.

Returns
Type Parameters
- TResult
Parameters
- selector: SelectorWithIndex<T, TResult>
Returns ExtendedIterable<TResult>
Inherited from ReadOnlyIterableCollectionBase.map
- Defined in ReadOnlyIterableCollectionBase.ts:52

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.

Throws
If the sequence is empty.

Returns
Type Parameters
- T
Parameters
- reduction: ((previous: T, current: T, index: number) => T)
  - - (previous: T, current: T, index: number): T
    - Parameters
      
      previous: T
      
      current: T
      
      index: number
      
      Returns T
Returns T
Inherited from ReadOnlyIterableCollectionBase.reduce
- Defined in ReadOnlyIterableCollectionBase.ts:66
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.

Returns
Type Parameters
- T
- U
Parameters
- reduction: ((previous: U, current: T, index: number) => U)
  - - (previous: U, current: T, index: number): U
    - Parameters
      
      previous: U
      
      current: T
      
      index: number
      
      Returns U
- initialValue: U
Returns U
Inherited from ReadOnlyIterableCollectionBase.reduce
- Defined in ReadOnlyIterableCollectionBase.ts:75

toArray

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

Returns

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

`Static` create

create<T>(source: Iterable<T>): ExtendedIterable<T>
Creates an ExtendedIterable wrapper for the provided source.

Returns
Type Parameters
- T
Parameters
- source: Iterable<T>
Returns ExtendedIterable<T>
- Defined in ReadOnlyIterableCollectionBase.ts:157

Class ExtendedIterable<T>

Type Parameters

T

Hierarchy

Index

Constructors

Methods

Constructors

Protected constructor

Type Parameters

T

Parameters

_source: Iterable<T>

Returns ExtendedIterable<T>

Methods

[iterator]

Returns Iterator<T, any, undefined>

Protected _getIterator

Returns Iterator<T, any, undefined>

copyTo

Returns

Type Parameters

TTarget extends ArrayLikeWritable<T, TTarget>

Parameters

target: TTarget

index: number = 0

Returns TTarget

filter

Returns

Parameters

predicate: PredicateWithIndex<T>

Returns ExtendedIterable<T>

getCount

Returns

Returns number

map

Returns

Type Parameters

TResult

Parameters

selector: SelectorWithIndex<T, TResult>

Returns ExtendedIterable<TResult>

reduce

Throws

Returns

Type Parameters

T

Parameters

reduction: ((previous: T, current: T, index: number) => T)

Parameters

previous: T

current: T

index: number

Returns T

Returns T

Returns

Type Parameters

T

U

Parameters

reduction: ((previous: U, current: T, index: number) => U)

Parameters

previous: U

current: T

index: number

Returns U

initialValue: U

Returns U

toArray

Returns

Returns T[]

Static create

Returns

Type Parameters

T

Parameters

source: Iterable<T>

Returns ExtendedIterable<T>

Settings

Member Visibility

`Protected` constructor

`Protected` _getIterator

`Static` create