Class: SortedMap<TKey, TValue>

Defined in: packages/db/src/SortedMap.ts:8

A Map implementation that keeps its entries sorted based on a comparator function

Type Parameters

TKey

TKey extends string | number

The type of keys in the map (must be string | number)

TValue

TValue

The type of values in the map

Constructors

Constructor

new SortedMap<TKey, TValue>(comparator?): SortedMap<TKey, TValue>;

new SortedMap<TKey, TValue>(comparator?): SortedMap<TKey, TValue>;

Defined in: packages/db/src/SortedMap.ts:19

Creates a new SortedMap instance

Parameters

comparator?

(a, b) => number

Optional function to compare values for sorting. If not provided, entries are sorted by key only.

Returns

SortedMap<TKey, TValue>

Accessors

size

Get Signature

get size(): number;

get size(): number;

Defined in: packages/db/src/SortedMap.ts:157

Gets the number of key-value pairs in the map

Returns

number

Methods

[iterator]()

iterator: IterableIterator<[TKey, TValue]>;

iterator: IterableIterator<[TKey, TValue]>;

Defined in: packages/db/src/SortedMap.ts:166

Default iterator that returns entries in sorted order

Returns

IterableIterator<[TKey, TValue]>

An iterator for the map's entries

clear()

clear(): void;

clear(): void;

Defined in: packages/db/src/SortedMap.ts:149

Removes all key-value pairs from the map

Returns

void

delete()

delete(key): boolean;

delete(key): boolean;

Defined in: packages/db/src/SortedMap.ts:125

Removes a key-value pair from the map

Parameters

key

TKey

The key to remove

Returns

boolean

True if the key was found and removed, false otherwise

entries()

entries(): IterableIterator<[TKey, TValue]>;

entries(): IterableIterator<[TKey, TValue]>;

Defined in: packages/db/src/SortedMap.ts:177

Returns an iterator for the map's entries in sorted order

Returns

IterableIterator<[TKey, TValue]>

An iterator for the map's entries

forEach()

forEach(callbackfn): void;

forEach(callbackfn): void;

Defined in: packages/db/src/SortedMap.ts:208

Executes a callback function for each key-value pair in the map in sorted order

Parameters

callbackfn

(value, key, map) => void

Function to execute for each entry

Returns

void

get()

get(key): TValue | undefined;

get(key): TValue | undefined;

Defined in: packages/db/src/SortedMap.ts:115

Gets a value by its key

Parameters

key

TKey

The key to look up

Returns

TValue | undefined

The value associated with the key, or undefined if not found

has()

has(key): boolean;

has(key): boolean;

Defined in: packages/db/src/SortedMap.ts:142

Checks if a key exists in the map

Parameters

key

TKey

The key to check

Returns

boolean

True if the key exists, false otherwise

keys()

keys(): IterableIterator<TKey>;

keys(): IterableIterator<TKey>;

Defined in: packages/db/src/SortedMap.ts:186

Returns an iterator for the map's keys in sorted order

Returns

IterableIterator<TKey>

An iterator for the map's keys

set()

set(key, value): this;

set(key, value): this;

Defined in: packages/db/src/SortedMap.ts:92

Sets a key-value pair in the map and maintains sort order

Parameters

key

TKey

The key to set

value

TValue

The value to associate with the key

Returns

this

This SortedMap instance for chaining

values()

values(): IterableIterator<TValue>;

values(): IterableIterator<TValue>;

Defined in: packages/db/src/SortedMap.ts:195

Returns an iterator for the map's values in sorted order

Returns

IterableIterator<TValue>

An iterator for the map's values