Class CollectionBase<T>`Abstract`

Base class for implementing an externally modifiable collection.

Type Parameters

Hierarchy

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:21

Properties

`Protected` _equalityComparer

_equalityComparer: EqualityComparison<T> = areEqual

Accessors

count

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

Returns

Returns number
Implementation of Collection.count

Inherited from ReadOnlyCollectionBase.count
- Defined in ReadOnlyCollectionBase.ts:29

version

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

Returns

Returns number
Implementation of Collection.version

Inherited from ReadOnlyCollectionBase.version
- Defined in IterableCollectionBase.ts:30

Methods

[iterator]

[iterator](): Iterator<T, any, undefined>
Returns Iterator<T, any, undefined>
Implementation of Collection.[iterator]

Inherited from ReadOnlyCollectionBase.[iterator]
- Defined in IterableCollectionBase.ts:47

`Protected` _addEntries

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

`Protected` `Abstract` _addInternal

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

`Protected` `Abstract` _clearInternal

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

`Protected` `Abstract` _removeInternal

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

add

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

addEntries

addEntries(entries: Iterable<T>): number
Safely imports the contents of an iterable.

Returns
Parameters
- entries: Iterable<T>
Returns number
Implementation of Collection.addEntries
- Defined in CollectionBase.ts:84

assertVersion

assertVersion(version: number): true
Throws if the provided version does not match the current one.

Returns
Parameters
- version: number
Returns true
Implementation of Collection.assertVersion

Inherited from ReadOnlyCollectionBase.assertVersion
- Defined in IterableCollectionBase.ts:40

clear

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

Returns

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

contains

contains(entry: T): boolean
Returns true if the equality comparer resolves true on any element in the collection.

Returns
Parameters
- entry: T
Returns boolean
Implementation of Collection.contains

Inherited from ReadOnlyCollectionBase.contains
- Defined in ReadOnlyCollectionBase.ts:39

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
Implementation of Collection.copyTo

Inherited from ReadOnlyCollectionBase.copyTo
- Defined in ReadOnlyIterableCollectionBase.ts:114

dispose

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

Returns void
- Defined in CollectionBase.ts:100

filter

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

Returns
Parameters
- predicate: PredicateWithIndex<T>
Returns ExtendedIterable<T>
Implementation of Collection.filter

Inherited from ReadOnlyCollectionBase.filter
- Defined in ReadOnlyIterableCollectionBase.ts:34

getCount

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

Returns

Returns number
Implementation of Collection.getCount

Overrides ReadOnlyCollectionBase.getCount
- Defined in CollectionBase.ts:30

incrementVersion

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

Returns
The new version.

Returns number
Implementation of Collection.incrementVersion

Inherited from ReadOnlyCollectionBase.incrementVersion
- Defined in IterableCollectionBase.ts:65

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>
Implementation of Collection.map

Inherited from ReadOnlyCollectionBase.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
Implementation of Collection.reduce

Inherited from ReadOnlyCollectionBase.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
Implementation of Collection.reduce

Inherited from ReadOnlyCollectionBase.reduce
- Defined in ReadOnlyIterableCollectionBase.ts:75

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.

Returns
The number of entries 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
Implementation of Collection.remove
- Defined in CollectionBase.ts:56

toArray

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

Returns

Returns T[]
Implementation of Collection.toArray

Inherited from ReadOnlyCollectionBase.toArray
- Defined in ReadOnlyIterableCollectionBase.ts:123

Class CollectionBase<T>Abstract

Type Parameters

T

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

Protected constructor

Type Parameters

T

Parameters

equalityComparer: EqualityComparison<T> = areEqual

Returns CollectionBase<T>

Properties

Protected _equalityComparer

Accessors

count

Returns

Returns number

version

Returns

Returns number

Methods

[iterator]

Returns Iterator<T, any, undefined>

Protected _addEntries

Parameters

entries: undefined | null | Iterable<T>

Returns number

Protected Abstract _addInternal

Parameters

entry: T

Returns boolean

Protected Abstract _clearInternal

Returns number

Protected Abstract _removeInternal

Parameters

entry: T

Optional max: number

Returns number

add

Parameters

entry: T

Returns CollectionBase<T>

addEntries

Returns

Parameters

entries: Iterable<T>

Returns number

assertVersion

Returns

Parameters

version: number

Returns true

clear

Returns

Returns number

contains

Returns

Parameters

entry: T

Returns boolean

copyTo

Returns

Type Parameters

TTarget extends ArrayLikeWritable<T, TTarget>

Parameters

target: TTarget

index: number = 0

Returns TTarget

dispose

Returns void

filter

Returns

Parameters

predicate: PredicateWithIndex<T>

Class CollectionBase<T>`Abstract`

`Protected` constructor

`Protected` _equalityComparer

`Protected` _addEntries

`Protected` `Abstract` _addInternal

`Protected` `Abstract` _clearInternal

`Protected` `Abstract` _removeInternal

`Optional` max: number