Class Dictionary<T, U>

A wrapper class for an associative array with object keys.

Note: This implementation uses ObjectIdentity to turn object keys into strings.

Type Parameters

T extends IdentityObject | IdentityFunction | null
U

Index

Constructors

Properties

Methods

clear get getKeys getValues put remove visit

Constructors

constructor

new Dictionary<T, U>(): Dictionary<T, U>
Type Parameters
- T extends null | IdentityObject | IdentityFunction
- U
Returns Dictionary<T, U>
- Defined in util/Dictionary.ts:33

Properties

map

map: Record<string, U> = {}

Stores the (key, value) pairs in this dictionary.

Methods

clear

clear(): void
Clears the dictionary.

Returns void
- Defined in util/Dictionary.ts:45

get

get(key): null | NonNullable<U>
Returns the value for the given key.
Parameters
- key: T
Returns null | NonNullable<U>
- Defined in util/Dictionary.ts:52

getKeys

getKeys(): string[]
Returns all keys as an array.

Returns string[]
- Defined in util/Dictionary.ts:82

getValues

getValues(): U[]
Returns all values as an array.

Returns U[]
- Defined in util/Dictionary.ts:93

put

put(key, value): null | NonNullable<U>
Stores the value under the given key and returns the previous value for that key.
Parameters
- key: T
- value: U
Returns null | NonNullable<U>
- Defined in util/Dictionary.ts:61

remove

remove(key): null | NonNullable<U>
Removes the value for the given key and returns the value that has been removed.
Parameters
- key: T
Returns null | NonNullable<U>
- Defined in util/Dictionary.ts:72

visit

visit(visitor): void
Visits all entries in the dictionary using the given function with the following signature: (key, value)=> where key is a string and value is an object.
Parameters
- visitor: Visitor<string, U>
  A function that takes the key and value as arguments.
Returns void
- Defined in util/Dictionary.ts:108