Class CollectionBase<T>`Abstract`

Base class for implementing an externally modifiable collection.

Type Parameters

Hierarchy (View Summary)

ReadOnlyCollectionBase<T>
- CollectionBase

Implements

Collection<T>

Index

Constructors

`Protected`constructor

new CollectionBase<T>(
equalityComparer?: EqualityComparison<T>,
): CollectionBase<T>
Type Parameters
- T
Parameters
- equalityComparer: EqualityComparison<T> = areEqual
Returns CollectionBase<T>
Overrides ReadOnlyCollectionBase.constructor
- Defined in CollectionBase.ts:20

Properties

`Protected`_equalityComparer

_equalityComparer: EqualityComparison<T> = areEqual

Accessors

count

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

Returns number
Implementation of Collection.count
Inherited from ReadOnlyCollectionBase.count
- Defined in ReadOnlyCollectionBase.ts:28

version

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

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

Methods

`Protected`_addEntries

_addEntries(entries: undefined | null | Iterable<T, any, any>): number
Parameters
- entries: undefined | null | Iterable<T, any, any>
Returns number
- Defined in CollectionBase.ts:110

`Protected` `Abstract`_addInternal

_addInternal(entry: T): boolean
Parameters
- entry: T
Returns boolean
- Defined in CollectionBase.ts:104

`Protected` `Abstract`_clearInternal

_clearInternal(): number
Returns number
- Defined in CollectionBase.ts:108

`Protected` `Abstract`_removeInternal

_removeInternal(entry: T, max?: number): number
Parameters
- entry: T
- Optionalmax: number
Returns number
- Defined in CollectionBase.ts:106

[iterator]

"[iterator]"(): Iterator<T>
Returns Iterator<T>
Implementation of Collection.[iterator]
Inherited from ReadOnlyCollectionBase.[iterator]
- Defined in IterableCollectionBase.ts:46

add

add(entry: T): this
Adds an entry to the collection.
Parameters
- entry: T
Returns this
Implementation of Collection.add
- Defined in CollectionBase.ts:38

addEntries

addEntries(entries: Iterable<T>): number
Safely imports the contents of an iterable.
Parameters
- entries: Iterable<T>
Returns number
Implementation of Collection.addEntries
- Defined in CollectionBase.ts:83

assertVersion

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

clear

clear(): number
Clears the contents of the collection resulting in a count of zero.

Returns number
Implementation of Collection.clear
- Defined in CollectionBase.ts:70

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 Collection.contains
Inherited from ReadOnlyCollectionBase.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 Collection.copyTo
Inherited from ReadOnlyCollectionBase.copyTo
- Defined in ReadOnlyIterableCollectionBase.ts:112

dispose

dispose(): void
Clears the collection. Provided for compatibility with disposal routines.

Returns void
- Defined in CollectionBase.ts:99

filter

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

getCount

getCount(): number
Returns the current number of entries.

Returns number
Implementation of Collection.getCount
Overrides ReadOnlyCollectionBase.getCount
- Defined in CollectionBase.ts:29

incrementVersion

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

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

remove

remove(entry: T, max?: number): number
Removes entries from the collection allowing for a limit. For example if the collection not a distinct set, more than one entry could be removed.
Parameters
- entry: T
  The entry to remove.
- max: number = Infinity
  Limit of entries to remove. Will remove all matches if no max specified.
Returns number
The number of entries removed.
Implementation of Collection.remove
- Defined in CollectionBase.ts:55

toArray

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

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

Class CollectionBase<T>Abstract

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

Protectedconstructor

Type Parameters

Parameters

Returns CollectionBase<T>

Properties

Protected_equalityComparer

Accessors

count

Returns number

version

Returns number

Methods

Protected_addEntries

Parameters

Returns number

Protected Abstract_addInternal

Parameters

Returns boolean

Protected Abstract_clearInternal

Returns number

Protected Abstract_removeInternal

Parameters

Returns number

[iterator]

Returns Iterator<T>

add

Parameters

Returns this

addEntries

Parameters

Returns number

assertVersion

Parameters

Returns true

clear

Returns number

contains

Parameters

Returns boolean

copyTo

Type Parameters

Parameters

Returns TTarget

dispose

Returns void

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

remove

Parameters

Returns number

toArray

Returns T[]

Settings

Class CollectionBase<T>`Abstract`

`Protected`constructor

`Protected`_equalityComparer

`Protected`_addEntries

`Protected` `Abstract`_addInternal

`Protected` `Abstract`_clearInternal

`Protected` `Abstract`_removeInternal