Class KeyMap<K, V, I, L>

Map that transforms keys.

Type Parameters

K
Input key type.
V
Value type.
I
Indexable key type.
L = K
Lookup key type.

Implements

Iterable<[key: K, value: V]>

Index

Constructors

Accessors

Methods

[iterator] delete get has set

Constructors

constructor

new KeyMap<K, V, I, L = K>(keyOf: (key: K | L) => I): KeyMap<K, V, I, L>
Constructor.
Type Parameters
- K
  Input key type.
- V
  Value type.
- I
  Indexable key type.
- L = K
  Lookup key type.
Parameters
- keyOf: (key: K | L) => I
  Function to transform input key to indexable key.
Returns KeyMap<K, V, I, L>
- Defined in pkg/util/src/key-map.ts:15

Accessors

size

get size(): number
Returns number
- Defined in pkg/util/src/key-map.ts:19

Methods

[iterator]

"[iterator]"(): IterableIterator<[key: K, value: V]>
Returns IterableIterator<[key: K, value: V]>
Implementation of Iterable.[iterator]
- Defined in pkg/util/src/key-map.ts:38

delete

delete(key: K | L): boolean
Parameters
- key: K | L
Returns boolean
- Defined in pkg/util/src/key-map.ts:34

get

get(key: K | L): V | undefined
Parameters
- key: K | L
Returns V | undefined
- Defined in pkg/util/src/key-map.ts:25

has

has(key: K | L): boolean
Parameters
- key: K | L
Returns boolean
- Defined in pkg/util/src/key-map.ts:21

set

set(key: K, value: V): this
Parameters
- key: K
- value: V
Returns this
- Defined in pkg/util/src/key-map.ts:29