interface BiMapFactory<UK,UV>

undocumented

Implemented by: BiMapCreators

Type parameters

Name	Default	Description
UK	unknown	undocumented
UV	unknown	undocumented

Methods

builder

Returns an empty BiMap builder instance.

Definition

builder<K extends UK, V extends UV>(): BiMap.Builder<K, V>;

Type parameters

Name	Constraints	Description
K	UK
V	UV

example

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

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>(): BiMap<K, V>;

Type parameters

Name	Constraints	Description
K	UK
V	UV

example

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

from

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

Definitions

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

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

Type parameters

Name	Constraints	Description
K	UK
V	UV

Parameters

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

example

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

of

Returns an immutable BiMap, containing the given entries.

Definition

of<K extends UK, V extends UV>(...entries: ArrayNonEmpty<readonly [K, V]>): BiMap.NonEmpty<K, V>;

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

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

reducer

Returns a Reducer that adds received tuples to a BiMap and returns the BiMap as a result. When a source is given, the reducer will first create a BiMap 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], BiMap<K, V>>;

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 = BiMap.of([1, 'a'], [2, 'b']);
const result = Stream.of([1, 'c'], [3, 'a']).reduce(BiMap.reducer(someSource))
result.toArray()   // => [[1, 'c'], [2, 'b'], [3, 'a']]

note

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