Class KeyMap<K, V, I, L>

Map that transforms keys.

K: input key type. V: value type. I: indexable key type. L: lookup key type.

Type Parameters

K
V
I
L = K

Hierarchy

KeyMap

Index

Constructors

Accessors

Methods

[iterator] delete get has set

Constructors

constructor

new KeyMap<K, V, I, L>(keyOf): KeyMap<K, V, I, L>
Constructor.
Type Parameters
- K
- V
- I
- L = K
Parameters
- keyOf: ((key) => I)
  
  function to transform input key to indexable key.
  - - (key): I
    - Parameters
      
      key: K | L
      
      Returns I
Returns KeyMap<K, V, I, L>
- Defined in packages/util/src/key-map.ts:14

Accessors

size

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

Methods

[iterator]

[iterator](): IterableIterator<[key: K, value: V]>
Returns IterableIterator<[key: K, value: V]>
- Defined in packages/util/src/key-map.ts:37

delete

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

get

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

has

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

set

set(key, value): KeyMap<K, V, I, L>
Parameters
- key: K
- value: V
Returns KeyMap<K, V, I, L>
- Defined in packages/util/src/key-map.ts:28

Generated using TypeDoc