Class ReadOnlyCollectionBase<T>`Abstract`

Base class for implementing an internally modifiable, eternally read-only collection.

Type Parameters

Hierarchy (View Summary)

IterableCollectionBase<T>
- ReadOnlyCollectionBase
  - CollectionBase

Implements

ReadOnlyCollection<T>

Index

Constructors

`Protected`constructor

new ReadOnlyCollectionBase<T>(
_equalityComparer?: EqualityComparison<T>,
): ReadOnlyCollectionBase<T>
Type Parameters
- T
Parameters
- _equalityComparer: EqualityComparison<T> = areEqual
Returns ReadOnlyCollectionBase<T>
Overrides IterableCollectionBase.constructor
- Defined in ReadOnlyCollectionBase.ts:18

Properties

`Protected`_equalityComparer

_equalityComparer: EqualityComparison<T> = areEqual

Accessors

count

get count(): number
Returns the current number of entries.

Returns number
Implementation of ReadOnlyCollection.count
- Defined in ReadOnlyCollectionBase.ts:28

version

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

Returns number
Implementation of ReadOnlyCollection.version
Inherited from IterableCollectionBase.version
- Defined in IterableCollectionBase.ts:29

Methods

[iterator]

"[iterator]"(): Iterator<T>
Returns Iterator<T>
Implementation of ReadOnlyCollection.[iterator]
Inherited from IterableCollectionBase.[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
Implementation of ReadOnlyCollection.assertVersion
Inherited from IterableCollectionBase.assertVersion
- Defined in IterableCollectionBase.ts:39

contains

contains(entry: T): boolean
Returns true if the equality comparer resolves true on any element in the collection.
Parameters
- entry: T
Returns boolean
Implementation of ReadOnlyCollection.contains
- Defined in ReadOnlyCollectionBase.ts:38

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
Implementation of ReadOnlyCollection.copyTo
Inherited from IterableCollectionBase.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>
Implementation of ReadOnlyCollection.filter
Inherited from IterableCollectionBase.filter
- Defined in ReadOnlyIterableCollectionBase.ts:32

getCount

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

Returns number
Implementation of ReadOnlyCollection.getCount
Inherited from IterableCollectionBase.getCount
- Defined in ReadOnlyIterableCollectionBase.ts:130

incrementVersion

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

Returns number
The new version.
Implementation of ReadOnlyCollection.incrementVersion
Inherited from IterableCollectionBase.incrementVersion
- 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>
Implementation of ReadOnlyCollection.map
Inherited from IterableCollectionBase.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.
Implementation of ReadOnlyCollection.reduce
Inherited from IterableCollectionBase.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
Implementation of ReadOnlyCollection.reduce
Inherited from IterableCollectionBase.reduce
- Defined in ReadOnlyIterableCollectionBase.ts:73

toArray

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

Returns T[]
Implementation of ReadOnlyCollection.toArray
Inherited from IterableCollectionBase.toArray
- Defined in ReadOnlyIterableCollectionBase.ts:121

Class ReadOnlyCollectionBase<T>Abstract

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

Protectedconstructor

Type Parameters

Parameters

Returns ReadOnlyCollectionBase<T>

Properties

Protected_equalityComparer

Accessors

count

Returns number

version

Returns number

Methods

[iterator]

Returns Iterator<T>

assertVersion

Parameters

Returns true

contains

Parameters

Returns boolean

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 ReadOnlyCollectionBase<T>`Abstract`

`Protected`constructor

`Protected`_equalityComparer