Interface Collection<T>

Interface for implementing an externally modifiable collection.

Type Parameters

Hierarchy

ReadOnlyCollection<T>
- Collection
  - IndexedCollection

Implemented by

CollectionBase

Index

Properties

count

count: number

Accessors

version

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

Returns

Returns number
Inherited from ReadOnlyCollection.version
- Defined in IterableCollectionBase.ts:30

Methods

[iterator]

[iterator](): Iterator<T, any, undefined>
Returns Iterator<T, any, undefined>
Inherited from ReadOnlyCollection.[iterator]
- Defined in IterableCollectionBase.ts:47

add

add(entry: T): Collection<T>
Parameters
- entry: T
Returns Collection<T>
- Defined in Collection.d.ts:15

addEntries

addEntries(entries: Iterable<T>): number
Parameters
- entries: Iterable<T>
Returns number
- Defined in Collection.d.ts:17

assertVersion

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

Returns
Parameters
- version: number
Returns true
Inherited from ReadOnlyCollection.assertVersion
- Defined in IterableCollectionBase.ts:40

clear

clear(): number
Returns number
- Defined in Collection.d.ts:20

contains

contains(entry: T): boolean
Parameters
- entry: T
Returns boolean
Inherited from ReadOnlyCollection.contains
- Defined in ReadOnlyCollection.d.ts:17

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
Inherited from ReadOnlyCollection.copyTo
- Defined in ReadOnlyIterableCollectionBase.ts:114

filter

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

Returns
Parameters
- predicate: PredicateWithIndex<T>
Returns ExtendedIterable<T>
Inherited from ReadOnlyCollection.filter
- Defined in ReadOnlyIterableCollectionBase.ts:34

getCount

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

Returns

Returns number
Inherited from ReadOnlyCollection.getCount
- Defined in ReadOnlyIterableCollectionBase.ts:132

incrementVersion

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

Returns
The new version.

Returns number
Inherited from ReadOnlyCollection.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>
Inherited from ReadOnlyCollection.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
Inherited from ReadOnlyCollection.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
Inherited from ReadOnlyCollection.reduce
- Defined in ReadOnlyIterableCollectionBase.ts:75

remove

remove(entry: T, max?: number): number
Parameters
- entry: T
- Optional max: number
Returns number
- Defined in Collection.d.ts:19

toArray

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

Returns

Returns T[]
Inherited from ReadOnlyCollection.toArray
- Defined in ReadOnlyIterableCollectionBase.ts:123

Interface Collection<T>

Type Parameters

T

Hierarchy

Implemented by

Index

Properties

Accessors

Methods

Properties

count

Accessors

version

Returns

Returns number

Methods

[iterator]

Returns Iterator<T, any, undefined>

add

Parameters

entry: T

Returns Collection<T>

addEntries

Parameters

entries: Iterable<T>

Returns number

assertVersion

Returns

Parameters

version: number

Returns true

clear

Returns number

contains

Parameters

entry: T

Returns boolean

copyTo

Returns

Type Parameters

TTarget extends ArrayLikeWritable<T, TTarget>

Parameters

target: TTarget

index: number = 0

Returns TTarget

filter

Returns

Parameters

predicate: PredicateWithIndex<T>

Returns ExtendedIterable<T>

getCount

Returns

Returns number

incrementVersion

Returns

Returns number

map

Returns

Type Parameters

TResult

Parameters

selector: SelectorWithIndex<T, TResult>

Returns ExtendedIterable<TResult>

reduce

Throws

Returns

Type Parameters

T

Parameters

reduction: ((previous: T, current: T, index: number) => T)

Parameters

previous: T

current: T

index: number

Returns T

Returns T

Returns

Type Parameters

T

U

`Optional` max: number