Interface SyncArena<K, V>

A Arena with synchronous operations.

interface SyncArena {
    add(value): K;
    delete(key, options?): unknown;
    get(key): undefined | V;
    has(key): boolean;
    set(key, value): void;
}

Type Parameters

K
V

Hierarchy

Arena<K, V>
- SyncArena

Implemented by

GenerationalArena

Index

Methods

add delete get has set

Methods

add

add(value): K
Adds a value to the arena and returns its key.
Parameters
- value: V
Returns K
Overrides Arena.add
- Defined in collections/src/generational.ts:16

delete

delete(key, options?): unknown
Deletes an entry by key from the map. Returns MaybePromise<unknown> to be compatible with ES Map.
Parameters
- key: K
- Optional options: AbortOptions
Returns unknown
Inherited from Arena.delete
- Defined in collections/src/map.ts:16

get

get(key): undefined | V
Gets a value by key from the map.
Parameters
- key: K
Returns undefined | V
Overrides Arena.get
- Defined in collections/src/generational.ts:20

has

has(key): boolean
Returns whether a key exists in the map.
Parameters
- key: K
Returns boolean
Overrides Arena.has
- Defined in collections/src/generational.ts:22

set

set(key, value): void
Updates a value on the arena. Does nothing if the key does not exist.
Parameters
- key: K
- value: V
Returns void
Overrides Arena.set
- Defined in collections/src/generational.ts:18

Generated using TypeDoc