Class ReadOnlyIterableCollectionBase<T>`Abstract`

Base class for implementing finite read-only iterables.

Type Parameters

T

Hierarchy (View Summary)

IterableBase<T>
- ReadOnlyIterableCollectionBase
  - IterableCollectionBase
  - ExtendedIterable

Index

Constructors

Methods

[iterator] copyTo filter getCount map reduce toArray

Constructors

`Protected`constructor

new ReadOnlyIterableCollectionBase<T>(): ReadOnlyIterableCollectionBase<T>
Type Parameters
- T
Returns ReadOnlyIterableCollectionBase<T>
Overrides IterableBase.constructor
- Defined in ReadOnlyIterableCollectionBase.ts:22

Methods

[iterator]

"[iterator]"(): Iterator<T>
Returns Iterator<T>
Inherited from IterableBase.[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
- 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>
- Defined in ReadOnlyIterableCollectionBase.ts:32

getCount

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

Returns number
- 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>
Overrides IterableBase.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.
- 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
- Defined in ReadOnlyIterableCollectionBase.ts:73

toArray

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

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