Class SetMap

source · [−]
Expand description

A Map containing sets of items

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

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

let map = new SetMap();
map.add('foo', 1); // foo: Set(1)
map.add('foo', 2); // foo: Set(1, 2)
map.add('foo', 1); // foo: Set(1)

Constructors

constructor

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

Accessors

source

get (): number

override
source

get (): number

The number of entries in the map

Methods

source

(key: TKey, value: TValue): void

Adds an item to the set at key.

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

source

(): void

Removes all entries from the map

source

(key: TKey): boolean

Removes the collection at key from the map.

source

(key: TKey, value: TValue): void

Removes a specified item from the set, if it is in the set.

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

source

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

Iterates over the key/value pairs of the map.

source

(): IterableIterator<[TKey, TValue]>

override
source

(callback: ((value: TValue, key: TKey, map: SetMap<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: Set<TValue>, key: TKey, map: SetMap<TKey, TValue>) => void)): void

Executes a callback for each entry in the map

source

(key: TKey): Set<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, collection: Set<TValue>): void

Sets the collection at key.

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

source

(): IterableIterator<Set<TValue>>

Iterates over the values of the map