Interface ReadonlyAutoKeyMap<K, V>

A readyonly map store with auto-generated key.

interface ReadonlyAutoKeyMap {
    get(key, options?): MaybePromise<undefined | V>;
    getKey(value, options?): MaybePromise<K>;
    has(key, options?): MaybePromise<boolean>;
}

Type Parameters

K = ContentId
V = Uint8Array

Hierarchy

MaybeAsyncReadonlyMap<K, V>
- ReadonlyAutoKeyMap
  - ReadonlyEventStore
  - AppendOnlyAutoKeyMap

Index

Methods

Methods

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 MaybeAsyncReadonlyMap.get
- Defined in collections/src/map.ts:7

getKey

getKey(value, options?): MaybePromise<K>
Gets the key of given value.
Parameters
- value: V
- Optional options: AbortOptions
Returns MaybePromise<K>
- Defined in collections/src/map.ts:25

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 MaybeAsyncReadonlyMap.has
- Defined in collections/src/map.ts:10

Generated using TypeDoc