Class CategoryCollection

Hierarchy

IndexedCollection<Category>
- CategoryCollection

Index

Accessors

Constructors

Methods

[iterator] _checkUniqueness _move _remove add clear destroy get getByKey has hasKey indexOf indexOfKey lower moveTo parseCategoryItems raise remove requestCategory from

Properties

_app _array _cache _moduleRemovedListener added moved removed

Accessors

previousIndexSymbol

get previousIndexSymbol(): symbol
Get the symbol which is attached to an item prior to its removal. If an item is removed, the current index of the item is set on the item with this symbol.

Returns symbol
Inherited from IndexedCollection.previousIndexSymbol
- Defined in src/util/indexedCollection.ts:44

size

get size(): number
Returns number
Inherited from IndexedCollection.size
- 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
Inherited from IndexedCollection.uniqueKey
- Defined in src/util/collection.ts:67

Constructors

constructor

new CategoryCollection(app): CategoryCollection
Parameters
- app: VcsApp
Returns CategoryCollection
Overrides IndexedCollection.constructor
- Defined in src/category/categoryCollection.ts:25

Methods

[iterator]

[iterator](): Generator<Category<object | VcsObject>, any, unknown>
Returns Generator<Category<object | VcsObject>, any, unknown>
Inherited from IndexedCollection.[iterator]
- Defined in src/util/collection.ts:57

`Protected` _checkUniqueness

_checkUniqueness(item): boolean
Parameters
- item: Category<object | VcsObject>
Returns boolean
Inherited from IndexedCollection._checkUniqueness
- Defined in src/util/collection.ts:86

`Protected` _move

_move(item, itemIndex, targetIndex): number
Parameters
- item: Category<object | VcsObject>
- itemIndex: number
- targetIndex: number
Returns number
Inherited from IndexedCollection._move
- Defined in src/util/indexedCollection.ts:84

`Protected` _remove

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

add

add(category): null | number
Do not call add directly. Use request category for adding categories.
Parameters
- category: Category<object | VcsObject>
Returns null | number
Overrides IndexedCollection.add
- Defined in src/category/categoryCollection.ts:45

clear

clear(): void
clears the array

Returns void
Inherited from IndexedCollection.clear
- Defined in src/util/collection.ts:164

destroy

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

Returns void
Overrides IndexedCollection.destroy
- Defined in src/category/categoryCollection.ts:135

get

get(index): Category<object | VcsObject>
Returns an item at index.
Parameters
- index: number
Returns Category<object | VcsObject>
Inherited from IndexedCollection.get
- Defined in src/util/indexedCollection.ts:52

getByKey

getByKey(value): undefined | Category<object | VcsObject>
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 | Category<object | VcsObject>
Inherited from IndexedCollection.getByKey
- Defined in src/util/collection.ts:79

has

has(item): boolean
Equivalent to Array.prototype.includes
Parameters
- item: Category<object | VcsObject>
Returns boolean
Inherited from IndexedCollection.has
- 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
Inherited from IndexedCollection.hasKey
- Defined in src/util/collection.ts:154

indexOf

indexOf(item): number
Returns the index of an item or -1 if it is not part of this collection
Parameters
- item: Category<object | VcsObject>
Returns number
Inherited from IndexedCollection.indexOf
- Defined in src/util/indexedCollection.ts:137

indexOfKey

indexOfKey(value): undefined | number
Returns the index of a key. Returns undefined, if there is no uniqueness constraint
Parameters
- value: unknown
Returns undefined | number
Inherited from IndexedCollection.indexOfKey
- Defined in src/util/indexedCollection.ts:144

lower

lower(item, steps?): null | number
Lowers an item within the array
Parameters
- item: Category<object | VcsObject>
- Optional steps: number = 1
  
  an integer number to lower by
Returns null | number
the new index of the item
Inherited from IndexedCollection.lower
- Defined in src/util/indexedCollection.ts:113

moveTo

moveTo(item, targetIndex): null | number
Moves an item to a provided index
Parameters
- item: Category<object | VcsObject>
- targetIndex: number
Returns null | number
the new index of the item
Inherited from IndexedCollection.moveTo
- Defined in src/util/indexedCollection.ts:100

parseCategoryItems

parseCategoryItems(name, items, moduleId): Promise<void>
Parses the category items. Items will only be parsed, if a category with said name exists. Otherwise, they will be cached, until such a category is requested.
Parameters
- name: string
- items: object[]
- moduleId: string
Returns Promise<void>
- Defined in src/category/categoryCollection.ts:77

raise

raise(item, steps?): null | number
Raises an item within the array
Parameters
- item: Category<object | VcsObject>
- Optional steps: number = 1
  
  an integer number to lower by
Returns null | number
the new index of the item
Inherited from IndexedCollection.raise
- Defined in src/util/indexedCollection.ts:126

remove

remove(category): void
Categories should be static. Removing them can lead to undefined behavior.
Parameters
- category: Category<object | VcsObject>
Returns void
Overrides IndexedCollection.remove
- Defined in src/category/categoryCollection.ts:67

requestCategory

requestCategory<T>(options): null | Category<T>
Add categories with this API.
Type Parameters
- T extends object | VcsObject
Parameters
- options: CategoryOptions<T>
Returns null | Category<T>
- Defined in src/category/categoryCollection.ts:96

`Static` from

from<F>(iterable, uniqueKey?): IndexedCollection<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 IndexedCollection<F>
Inherited from IndexedCollection.from
- Defined in src/util/indexedCollection.ts:8

Properties

`Private` _app

_app: VcsApp

`Protected` _array

_array: Category<object | VcsObject>[]

`Private` _cache

_cache: Map<string, Map<string, object[]>> = ...

Map of category names, where the value is a map of moduleId and items.

`Private` _moduleRemovedListener

_moduleRemovedListener: (() => void)

Type declaration

- (): void
- Returns void

added

added: VcsEvent<Category<object | VcsObject>>

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

moved

moved: VcsEvent<Category<object | VcsObject>>

Event raised if an item is relocated within the collection. Is passed the moved item.

removed

removed: VcsEvent<Category<object | VcsObject>>

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

Class CategoryCollection

Hierarchy

Index

Accessors

Constructors

Methods

Properties

Accessors

previousIndexSymbol

Returns symbol

size

Returns number

uniqueKey

Returns undefined | keyof T

Constructors

constructor

Parameters

app: VcsApp

Returns CategoryCollection

Methods

[iterator]

Returns Generator<Category<object | VcsObject>, any, unknown>

Protected _checkUniqueness

Parameters

item: Category<object | VcsObject>

Returns boolean

Protected _move

Parameters

item: Category<object | VcsObject>

itemIndex: number

targetIndex: number

Returns number

Protected _remove

Parameters

item: Category<object | VcsObject>

Returns number

add

Parameters

category: Category<object | VcsObject>

Returns null | number

clear

Returns void

destroy

Returns void

get

Parameters

index: number

Returns Category<object | VcsObject>

getByKey

Parameters

value: unknown

Returns undefined | Category<object | VcsObject>

has

Parameters

item: Category<object | VcsObject>

Returns boolean

hasKey

Parameters

value: unknown

Returns undefined | boolean

indexOf

Parameters

item: Category<object | VcsObject>

Returns number

indexOfKey

Parameters

value: unknown

Returns undefined | number

lower

Parameters

item: Category<object | VcsObject>

Optional steps: number = 1

Returns null | number

moveTo

Parameters

item: Category<object | VcsObject>

targetIndex: number

Returns null | number

parseCategoryItems

Parameters

`Protected` _checkUniqueness

`Protected` _move

`Protected` _remove

`Optional` steps: number = 1

`Optional` steps: number = 1

`Static` from

`Optional` uniqueKey: false | keyof F

`Private` _app

`Protected` _array

`Private` _cache

`Private` _moduleRemovedListener