interface BiMultiMapBase.Context<UK,UV,Tp>

undocumented

Extends: BiMultiMapBase.Factory<UK,UV,Tp>

Implemented by: SortedBiMultiMap.Context<UK,UV>, BiMultiMap.Context<UK,UV>, BiMultiMapContext<UK,UV,N,Tp>, HashBiMultiMap.Context<UK,UV>

Type parameters

Name	Constraints	Default	Description
UK			undocumented
UV			undocumented
Tp	BiMultiMapBase.Types	BiMultiMapBase.Types	undocumented

Properties

_fixTypes

undocumented

Definition

readonly _fixTypes: readonly [UK, UV];

_types

undocumented

Definition

readonly _types: Tp;

keyValueMultiMapContext

undocumented

Definition

readonly keyValueMultiMapContext: WithKeyValue<Tp, UK, UV>['keyValueMultiMapContext'];

typeTag

A string tag defining the specific collection type

Definition

readonly typeTag: string;

example

HashBiMultiMap.defaultContext().typeTag   // => 'HashBiMultiMap'

valueKeyMultiMapContext

undocumented

Definition

readonly valueKeyMultiMapContext: WithKeyValue<Tp, UK, UV>['valueKeyMultiMapContext'];

Methods

builder

Returns an empty BiMultiMap builder instance.

Definition

builder<K extends UK, V extends UV>(): WithKeyValue<Tp, K, V>['builder'];

Type parameters

Name	Constraints	Description
K	UK
V	UV

example

HashBiMultiMap.builder<number, string>()    // => HashBiMultiMap.Builder<number, string>

Overrides

Factory.builder

empty

Returns the (singleton) empty instance of this type and context with given key and value types.

Definition

empty<K extends UK, V extends UV>(): WithKeyValue<Tp, K, V>['normal'];

Type parameters

Name	Constraints	Description
K	UK
V	UV

example

HashBiMultiMap.empty<number, string>()    // => HashBiMultiMap<number, string>
HashBiMultiMap.empty<string, boolean>()   // => HashBiMultiMap<string, boolean>

Overrides

Factory.empty

from

Returns an immutable BiMultiMap, containing the entries in the given sources StreamSource instances.

Definitions

from<K extends UK, V extends UV>(...sources: ArrayNonEmpty<StreamSource.NonEmpty<readonly [K, V]>>): WithKeyValue<Tp, K, V>['nonEmpty'];

from<K extends UK, V extends UV>(...sources: ArrayNonEmpty<StreamSource<readonly [K, V]>>): WithKeyValue<Tp, K, V>['normal'];

Type parameters

Name	Constraints	Description
K	UK
V	UV

Parameters

Name	Type	Description
sources	ArrayNonEmpty<StreamSource.NonEmpty<readonly [K, V]>>	an array of StreamSource instances contaning key-value entries

example

HashBiMultiMap.from([[1, 'a'], [2, 'b']])    // => HashBiMultiMap.NonEmpty<number, string>

Overrides

Factory.from

of

Returns an immutable BiMultiMap, containing the given entries.

Definition

of<K extends UK, V extends UV>(...entries: ArrayNonEmpty<readonly [K, V]>): WithKeyValue<Tp, K, V>['nonEmpty'];

Type parameters

Name	Constraints	Description
K	UK
V	UV

Parameters

Name	Type	Description
entries	ArrayNonEmpty<readonly [K, V]>	a non-empty array of key-value entries

example

HashBiMultiMap.of([1, 'a'], [2, 'b'])    // => HashBiMultiMap.NonEmpty<number, string>

Overrides

Factory.of

reducer

Returns a Reducer that adds received tuples to a BiMultiMap and returns the BiMultiMap as a result. When a source is given, the reducer will first create a BiMultiMap from the source, and then add tuples to it.

Definition

reducer<K extends UK, V extends UV>(source?: StreamSource<readonly [K, V]>): Reducer<readonly [K, V], WithKeyValue<Tp, K, V>['normal']>;

Type parameters

Name	Constraints	Description
K	UK
V	UV

Parameters

Name	Type	Description
source	StreamSource<readonly [K, V]>	(optional) an initial source of tuples to add to

example

const someSource = BiMultiMap.of([1, 'a'], [2, 'b']);
const result = Stream.of([1, 'c'], [3, 'a']).reduce(BiMultiMap.reducer(someSource))
result.toArray()   // => [[1, 'a'], [1, 'c'], [2, 'b'], [3, 'a']]

note

uses a builder under the hood. If the given source is a BiMultiMap in the same context, it will directly call .toBuilder().

Overrides

Factory.reducer