Class CategoryCollection

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

size

• get size(): number

• Returns number

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

[iterator]

• [iterator](): Generator<Category<object | VcsObject, object>, any, any>

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

clear

• clear(): void

• clears the array

  Returns void

get

• get(index): Category<object | VcsObject, object>

• Returns an item at index.

  Parameters

  • index: number

  Returns Category<object | VcsObject, object>

getByKey

• getByKey(value): undefined | Category<object | VcsObject, object>

• 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, object>

has

• has(item): boolean

• Equivalent to Array.prototype.includes

  Parameters

  • item: Category<object | VcsObject, object>

  Returns boolean

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

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, object>

  Returns number

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

lower

• lower(item, steps?): null | number

• Lowers an item within the array

  Parameters

  • item: Category<object | VcsObject, object>
  • Optionalsteps: number = 1

    an integer number to lower by

  Returns null | number

  the new index of the item

moveTo

• moveTo(item, targetIndex): null | number

• Moves an item to a provided index

  Parameters

  • item: Category<object | VcsObject, object>
  • targetIndex: number

  Returns null | number

  the new index of the item

raise

• raise(item, steps?): null | number

• Raises an item within the array

  Parameters

  • item: Category<object | VcsObject, object>
  • Optionalsteps: number = 1

    an integer number to lower by

  Returns null | number

  the new index of the item

Staticfrom

• from<F>(iterable, uniqueKey?): IndexedCollection<F>

• Creates a Collection from an iterable, such as an Array.

  Type Parameters

  • F

  Parameters

  • iterable: Iterable<F, any, any>
  • OptionaluniqueKey: false | keyof F

    a key to maintain uniquely within the collection. passing false disables uniqueness.

  Returns IndexedCollection<F>

added

moved

removed