Class HashArray<T>

constructor

• new HashArray<T extends object>(
      keyFields?: string | KeyFields,
      options?: HashArrayOptions<T>,
  ): HashArray<T>

• Type Parameters

  • T extends object

  Parameters

  • OptionalkeyFields: string | KeyFields

    A single string or an array of strings / arrays representing what fields on added objects are to be used as keys for the trie search / HashArray.
  • Optionaloptions: HashArrayOptions<T>

    Options.

  Returns HashArray<T>

keyFields

• get keyFields(): KeyFields

• Returns KeyFields

  A clone of the current key fields.

size

• get size(): number

• Returns number

  The mapped size; number of keys in HashArray.

sizeFlat

• get sizeFlat(): number

• Returns number

  The flattened size; number of items in HashArray.

add

• add(...items: (T | Iterable<T, any, any>)[]): this

• Add items or list of items to the HashArray instance.

  Parameters

  • ...items: (T | Iterable<T, any, any>)[]

    Items to add.

  Returns this

  This instance.

clear

• clear(): this

• Clears all items.

  Returns this

  This instance.

clone

• clone(opts?: { items?: CloneOps; options?: HashArrayOptions<T> }): HashArray<T>

• Clones this HashArray. By default, returning an empty HashArray with cloned KeyFields. Set items in options to CloneOps.SHALLOW to copy the items. To fully clone all items set CloneOps.DEEP.

  Parameters

  • Optionalopts: { items?: CloneOps; options?: HashArrayOptions<T> }

    Optional parameters.

    • Optionalitems?: CloneOps

      Clone operation for items. By default, no items are included in the clone. Supply SHALLOW and items are copied. Supply DEEP and items are cloned as well.

    • Optionaloptions?: HashArrayOptions<T>

      Optional change to options for the clone that is merged with current HashArray options.

  Returns HashArray<T>

collides

• collides(item: Partial<T>): boolean

• Detects if the given item collides with an existing key / item pair.

  Parameters

  • item: Partial<T>

    A partial item to check for collision.

  Returns boolean

  Is there a collision?

entries

• entries(): IterableIterator<[string, T[]], any, any>

• Returns IterableIterator<[string, T[]], any, any>

  An entries iterator w/ key and all associated values.

entriesFlat

• entriesFlat(): IterableIterator<[string, T], any, any>

• Returns IterableIterator<[string, T], any, any>

  Generator of flattened entries.

  Yields

filter

• filter(key: Key, callbackOrIndex: Key | (item: T) => boolean): HashArray<T>

• Filters this HashArray returning a new HashArray with the items that pass the given filter test.

  Parameters

  • key: Key

    The Key to retrieve item(s) to iterate.
  • callbackOrIndex: Key | (item: T) => boolean

    A Key to lookup for filter inclusion or a callback function returning the filter result for the item.

  Returns HashArray<T>

forEach

• forEach(key: Key, callback: (item: T) => void): this

• Iterates over all items retrieved by the given key invoking the callback function for each item.

  Parameters

  • key: Key

    The Key to retrieve items to iterate.
  • callback: (item: T) => void

    A callback invoked for each item.

  Returns this

  This instance.

forEachDeep

• forEachDeep(key: Key, index: Key, callback: (value: any, item: T) => void): this

• Iterates over all items retrieved by the given key invoking the callback function for each item with the value found by the index Key and the item itself.

  Parameters

  • key: Key

    The Key to retrieve item(s) to iterate.
  • index: Key

    A specific Key in each item to lookup.
  • callback: (value: any, item: T) => void

    A callback invoked for each item with value of index and item.

  Returns this

  This instance.

get

• get(key: string): T | T[]

• Gets item(s) by the given key.

  Parameters

  • key: string

    The key for an item to retrieve.

  Returns T | T[]

  All items stored by the given key.

getAll

• getAll(keys: Key): T[]

• Gets all items stored by the given Key. You may pass * as a wildcard for all items.

  Parameters

  • keys: Key

    The Key for item(s) to retrieve.

  Returns T[]

  All item(s) for the given Key.

getAsArray

• getAsArray(key: string): T[]

• Gets item(s) by the given key always returning an array including an empty array when key is not in the HashArray.

  Parameters

  • key: string

    The key for item(s) to retrieve.

  Returns T[]

  All items for key or empty array.

getAt

• getAt(index: number): T

• Gets the item stored in the flat list of all items at the given index.

  Parameters

  • index: number

    The index to retrieve.

  Returns T

has

• has(key: string): boolean

• Verifies if this HashArray has this key.

  Parameters

  • key: string

    The key to check.

  Returns boolean

  Whether this HashArray already has the given key.

intersection

• intersection(target: HashArray<T>, output?: HashArray<T>): HashArray<T>

• Returns the intersection of this HashArray and a target HashArray.

  Parameters

  • target: HashArray<T>

    Another HashArray.
  • Optionaloutput: HashArray<T>

    Optional output HashArray.

  Returns HashArray<T>

  Returns a new HashArray that contains the intersection between this (A) and the HashArray passed in (B). Returns A ^ B.

keys

• keys(): IterableIterator<string, any, any>

• Returns IterableIterator<string, any, any>

  A keys iterator.

remove

• remove(...items: T[]): this

• Removes all item(s) given.

  Parameters

  • ...items: T[]

    Items to remove.

  Returns this

  This instance.

removeByKey

• removeByKey(...keys: string[]): this

• Remove item(s) associated with the given keys from the HashArray.

  Parameters

  • ...keys: string[]

    Keys associated with the item(s) to be removed.

  Returns this

  This instance.

removeFirst

• removeFirst(): this

• When treating HashArray as a cache removing the first item removes the oldest item.

  Returns this

  This instance.

removeLast

• removeLast(): this

• When treating HashArray as a cache removing the last item removes the newest item.

  Returns this

  This instance.

values

• values(): IterableIterator<T[], any, any>

• Returns IterableIterator<T[], any, any>

  A values iterator / all items values grouped by key.

valuesFlat

• valuesFlat(): IterableIterator<T, any, any>

• Returns IterableIterator<T, any, any>

  A flat values iterator by default in order added.

Static ReadonlyCloneOps