Class Dictionary<K, V>

Type Parameters

K extends string | number | symbol
V

Index

Constructors

Accessors

Methods

[iterator] clear delete entries get has keys set sortedEntries toJSON values

Constructors

constructor

new Dictionary<K extends string | number | symbol, V>(): Dictionary<K, V>
Type Parameters
- K extends string | number | symbol
- V
Returns Dictionary<K, V>

Accessors

size

get size(): number
Gets the number of entries in the dictionary.

Returns number
The count of stored key-value pairs.
- Defined in core/Dictionary.ts:82

Methods

[iterator]

"[iterator]"(): IterableIterator<[K, V]>
Iterator to allow looping over dictionary entries using for...of.

Returns IterableIterator<[K, V]>
- Defined in core/Dictionary.ts:109

clear

clear(): void
Clears all entries in the dictionary.

Returns void
- Defined in core/Dictionary.ts:74

delete

delete(key: K): boolean
Deletes a key-value pair from the dictionary.
Parameters
- key: K
  The key to remove.
Returns boolean
true if the key was deleted, otherwise false.
- Defined in core/Dictionary.ts:38

entries

entries(): [K, V][]
Returns an array of key-value pairs.

Returns [K, V][]
An array of [key, value] tuples.
- Defined in core/Dictionary.ts:67

get

get(key: K): undefined | V
Retrieves the value associated with a key.
Parameters
- key: K
  The key to look up.
Returns undefined | V
The value or undefined if not found.
- Defined in core/Dictionary.ts:20

has

has(key: K): boolean
Checks if the dictionary contains a specific key.
Parameters
- key: K
  The key to check.
Returns boolean
true if the key exists, otherwise false.
- Defined in core/Dictionary.ts:29

keys

keys(): K[]
Returns all keys in the dictionary.

Returns K[]
An array of keys.
- Defined in core/Dictionary.ts:50

set

set(key: K, value: V): void
Sets a key-value pair in the dictionary.
Parameters
- key: K
  The unique key.
- value: V
  The associated value.
Returns void
- Defined in core/Dictionary.ts:11

sortedEntries

sortedEntries(ascending?: boolean): [K, V][]
Returns a sorted array of entries based on keys.
Parameters
- ascending: boolean = true
  Whether to sort in ascending order (true by default).
Returns [K, V][]
A sorted array of [key, value] tuples.
- Defined in core/Dictionary.ts:91

toJSON

toJSON(pretty?: boolean): string
Serializes the dictionary into a JSON string.
Parameters
- pretty: boolean = false
  Whether to format with indentation (false by default).
Returns string
A JSON representation of the dictionary.
- Defined in core/Dictionary.ts:102

values

values(): V[]
Returns all values in the dictionary.

Returns V[]
An array of values.
- Defined in core/Dictionary.ts:58