Interface Arena<K, V>

An arena automatically assigns unique key to stored value.

interface Arena {
    add(value): MaybePromise<K>;
    delete(key, options?): unknown;
    get(key, options?): MaybePromise<undefined | V>;
    has(key, options?): MaybePromise<boolean>;
    set(key, value): unknown;
}

Type Parameters

K
V

Hierarchy

MaybeAsyncMap<K, V>
- Arena
  - SyncArena

Index

Methods

add delete get has set

Methods

add

add(value): MaybePromise<K>
Adds a value to the arena and returns its key.
Parameters
- value: V
Returns MaybePromise<K>
- Defined in collections/src/generational.ts:8

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 MaybeAsyncMap.delete
- Defined in collections/src/map.ts:16

get

get(key, options?): MaybePromise<undefined | V>
Gets a value by key from the map.
Parameters
- key: K
- Optional options: AbortOptions
Returns MaybePromise<undefined | V>
Inherited from MaybeAsyncMap.get
- Defined in collections/src/map.ts:7

has

has(key, options?): MaybePromise<boolean>
Returns whether a key exists in the map.
Parameters
- key: K
- Optional options: AbortOptions
Returns MaybePromise<boolean>
Inherited from MaybeAsyncMap.has
- Defined in collections/src/map.ts:10

set

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

Generated using TypeDoc