Interface AutoKeyMap<K, V>

A map store with auto-generated key.

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

Type Parameters

K = ContentId
V = Uint8Array

Hierarchy

AppendOnlyAutoKeyMap<K, V>
- AutoKeyMap

Implemented by

ContentAddressedMapStore

Index

Methods

delete get getKey has put

Methods

delete

delete(key, options?): MaybePromise<void>
Deletes the value with given key.
Parameters
- key: K
- Optional options: AbortOptions
Returns MaybePromise<void>
- Defined in collections/src/map.ts:31

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 AppendOnlyAutoKeyMap.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>
Inherited from AppendOnlyAutoKeyMap.getKey
- 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 AppendOnlyAutoKeyMap.has
- Defined in collections/src/map.ts:10

put

put(value, options?): MaybePromise<K>
Puts given value and returns its key.
Parameters
- value: V
- Optional options: AbortOptions
Returns MaybePromise<K>
Inherited from AppendOnlyAutoKeyMap.put
- Defined in collections/src/map.ts:37

Interface AutoKeyMap<K, V>

Type Parameters

K = ContentId

V = Uint8Array

Hierarchy

Implemented by

Index

Methods

Methods

delete

Parameters

key: K

`Optional` options: AbortOptions

Returns MaybePromise<void>

get

Parameters

key: K

`Optional` options: AbortOptions

Returns MaybePromise<undefined | V>

getKey

Parameters

value: V

`Optional` options: AbortOptions

Returns MaybePromise<K>

has

Parameters

key: K

`Optional` options: AbortOptions

Returns MaybePromise<boolean>

put

Parameters

value: V

`Optional` options: AbortOptions

Returns MaybePromise<K>

Settings

Member Visibility

Theme

On This Page

Interface AutoKeyMap<K, V>

Type Parameters

K = ContentId

V = Uint8Array

Hierarchy

Implemented by

Index

Methods

Methods

delete

Parameters

key: K

Optional options: AbortOptions

Returns MaybePromise<void>

get

Parameters

key: K

Optional options: AbortOptions

Returns MaybePromise<undefined | V>

getKey

Parameters

value: V

Optional options: AbortOptions

Returns MaybePromise<K>

has

Parameters

key: K

Optional options: AbortOptions

Returns MaybePromise<boolean>

put

Parameters

value: V

Optional options: AbortOptions

Returns MaybePromise<K>

Settings

Member Visibility

Theme

On This Page

`Optional` options: AbortOptions

`Optional` options: AbortOptions

`Optional` options: AbortOptions

`Optional` options: AbortOptions

`Optional` options: AbortOptions