Class ArrayMap

source · [−]
Expand description

A Map containing arrays of items

This class contains the standard Map methods as well as a subset of Array methods for convenient access to the underlying array.

import { ArrayMap } from '@woubuc/multimap';

let map = new ArrayMap();
map.set('foo', [1]); // foo: [1]
map.push('foo', 2); // foo: [1, 2]
map.delete('foo'); // foo: undefined
map.push('foo', 3); // foo: [3]

Constructors

constructor

new <TKey, TValue>(): ArrayMap<TKey, TValue>

Accessors

source

get (): number

override
source

get (): number

The number of entries in the map

Methods

source

(): void

Removes all entries from the map

source

(key: TKey): boolean

Removes the collection at key from the map.

source

(): IterableIterator<[TKey, TValue[]]>

Iterates over the key/value pairs of the map.

source

(): IterableIterator<[TKey, TValue]>

override
source

(callback: ((value: TValue, key: TKey, map: ArrayMap<TKey, TValue>) => void)): void

Executes a callback for all items in all collections in the map.

This method flattens the entries, so the iterator may contain the same key multiple times. It will also skip over empty collections.

source

(): IterableIterator<TValue>

override
source

(callback: ((value: TValue[], key: TKey, map: ArrayMap<TKey, TValue>) => void)): void

Executes a callback for each entry in the map

source

(key: TKey): TValue[]

override
source

(key: TKey): boolean

Checks if key exists in the map.

source

(): IterableIterator<TKey>

Iterates over the keys of the map

source

(key: TKey): undefined | TValue

Removes the last element from the array at key.

If no entry exists for key, creates a new array.

source

(key: TKey, ...values: TValue[]): void

Adds one or more items to the end of the array at key.

If no entry exists for key, creates a new array.

source

(key: TKey): void

Reverses the array at key in place.

If no entry exists for key, creates a new array.

source

(key: TKey, collection: TValue[]): void

Sets the collection at key.

If no entry exists for key, returns an empty collection.

source

(key: TKey): undefined | TValue

Removes the first element from the array at key and returns the removed element.

If no entry exists for key, creates a new array.

source

(key: TKey, compareFn?: ((a: TValue, b: TValue) => number)): void

Sorts the elements of the array at key in place, with an optional compare function.

Uses the standard Array.sort() functionality so the same complexity and considerations apply.

If no entry exists for key, creates a new array.

source

(key: TKey, ...values: TValue[]): void

Adds one or more items to the beginning of the array at key.

If no entry exists for key, creates a new array.

source

(): IterableIterator<TValue[]>

Iterates over the values of the map