Class Collection<T>

A generic array based collection. Implements the Symbol.iterator (e.g. [...collection])

Type Parameters

T

Hierarchy

Collection
- IndexedCollection
- MapCollection

Index

Accessors

Constructors

Methods

[iterator] _checkUniqueness _remove add clear destroy getByKey has hasKey remove from

Properties

_array _uniqueKey added removed

Accessors

size

get size(): number
Returns number
- Defined in src/util/collection.ts:71

uniqueKey

get uniqueKey(): undefined | keyof T
The key by which to check uniqueness against. undefined if no uniqueness constraint is set.

Returns undefined | keyof T
- Defined in src/util/collection.ts:67

Constructors

constructor

new Collection<T>(uniqueKey?): Collection<T>
Type Parameters
- T
Parameters
- Optional uniqueKey: false | keyof T
  
  a key to maintain uniquely within the collection. passing false disables uniqueness.
Returns Collection<T>
- Defined in src/util/collection.ts:43

Methods

[iterator]

[iterator](): Generator<T, any, unknown>
Returns Generator<T, any, unknown>
- Defined in src/util/collection.ts:57

`Protected` _checkUniqueness

_checkUniqueness(item): boolean
Parameters
- item: T
Returns boolean
- Defined in src/util/collection.ts:86

`Protected` _remove

_remove(item): number
Protected
internal remove function, to remove an item from the collection, does not raise an event.
Parameters
- item: T
Returns number
returns the index of the removed item or -1 if the item has not been found.
- Defined in src/util/collection.ts:123

add

add(item): null | number
Adds an item to the collection.
Parameters
- item: T
  
  the item to be inserted
Returns null | number
the index at which the item was inserted
- Defined in src/util/collection.ts:108

clear

clear(): void
clears the array

Returns void
- Defined in src/util/collection.ts:164

destroy

destroy(): void
Destroys the collection, clearing the array and all its events

Returns void
- Defined in src/util/collection.ts:174

getByKey

getByKey(value): undefined | T
Returns an item identified by the unique constraint key. Returns null, if there is no uniqueness constraint.
Parameters
- value: unknown
  
  the value to test against. does a shallow comparison, if the passed a non-atomic value
Returns undefined | T
- Defined in src/util/collection.ts:79

has

has(item): boolean
Equivalent to Array.prototype.includes
Parameters
- item: T
Returns boolean
- Defined in src/util/collection.ts:146

hasKey

hasKey(value): undefined | boolean
Returns true, if the key exists. Returns undefined, if there is no uniqueness constraint.
Parameters
- value: unknown
Returns undefined | boolean
- Defined in src/util/collection.ts:154

remove

remove(item): void
Removes an item from the collection
Parameters
- item: T
Returns void
- Defined in src/util/collection.ts:135

`Static` from

from<F>(iterable, uniqueKey?): Collection<F>
Creates a Collection from an iterable, such as an Array.
Type Parameters
- F
Parameters
- iterable: Iterable<F>
- Optional uniqueKey: false | keyof F
  
  a key to maintain uniquely within the collection. passing false disables uniqueness.
Returns Collection<F>
- Defined in src/util/collection.ts:13

Properties

`Protected` _array

_array: T[]

`Private` `Readonly` _uniqueKey

_uniqueKey: undefined | keyof T

added

added: VcsEvent<T>

Event raised if an item is added. Is passed the added item.

removed

removed: VcsEvent<T>

Event raised if an item is removed. Is passed the removed item.

Generated using TypeDoc