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.

Hierarchy (View Summary)

KeyMap
- NameMap

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<V, I, L>
Constructor.
Type Parameters
- K
- V
- I
- L = K
Parameters
- keyOf: (key: K | L) => I
  Function to transform input key to indexable key.
Returns KeyMap<V, I, L>
- Defined in pkg/util/src/key-map.ts:13

Accessors

size

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

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:36

delete

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

get

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

has

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

set

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