Class Collection<T>

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

Type Parameters

T

Hierarchy (View Summary)

Collection

Index

Accessors

Constructors

Methods

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

Properties

_array added removed

Accessors

size

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

uniqueKey

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

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

Constructors

constructor

new Collection<T>(uniqueKey?: false | keyof T): Collection<T>
Type Parameters
- T
Parameters
- OptionaluniqueKey: 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

`Protected`_checkUniqueness

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

`Protected`_remove

_remove(item: T): 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

[iterator]

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

add

add(item: T): number | null
Adds an item to the collection.
Parameters
- item: T
  the item to be inserted
Returns number | null
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: unknown): T | undefined
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 T | undefined
- Defined in src/util/collection.ts:79

has

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

hasKey

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

remove

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

`Static`from

from<F>(iterable: Iterable<F>, uniqueKey?: false | keyof F): Collection<F>
Creates a Collection from an iterable, such as an Array.
Type Parameters
- F
Parameters
- iterable: Iterable<F>
- OptionaluniqueKey: 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[]

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.