Class IterableCollectionBase<T>`Abstract`

Base class for implementing an iterable (finite) collection.

Type Parameters

Hierarchy (View Summary)

ReadOnlyIterableCollectionBase<T>
- IterableCollectionBase
  - ReadOnlyCollection
  - ReadOnlyCollectionBase

Index

Constructors

`Protected`constructor

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

Accessors

version

get version(): number
The version number used to track changes.

Returns number
- Defined in IterableCollectionBase.ts:29

Methods

[iterator]

"[iterator]"(): Iterator<T>
Returns Iterator<T>
Overrides ReadOnlyIterableCollectionBase.[iterator]
- Defined in IterableCollectionBase.ts:46

assertVersion

assertVersion(version: number): true
Throws if the provided version does not match the current one.
Parameters
- version: number
Returns true
- Defined in IterableCollectionBase.ts:39

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

incrementVersion

incrementVersion(): number
Increments the collection version. Useful for tracking changes.

Returns number
The new version.
- Defined in IterableCollectionBase.ts:64

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

Class IterableCollectionBase<T>Abstract

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

Protectedconstructor

Type Parameters

Returns IterableCollectionBase<T>

Accessors

version

Returns number

Methods

[iterator]

Returns Iterator<T>

assertVersion

Parameters

Returns true

copyTo

Type Parameters

Parameters

Returns TTarget

filter

Parameters

Returns ExtendedIterable<T>

getCount

Returns number

incrementVersion

Returns number

map

Type Parameters

Parameters

Returns ExtendedIterable<TResult>

reduce

Type Parameters

Parameters

Returns T

Throws

Type Parameters

Parameters

Returns U

toArray

Returns T[]

Settings

On This Page

Class IterableCollectionBase<T>`Abstract`

`Protected`constructor