Type Alias BoxMap<TKey, TValue>

Creates a BoxMap proxy object offering methods of getting and setting a set of values stored in individual boxes indexed by a common key type

Param: options

Options for creating the BoxMap proxy

type BoxMap<TKey, TValue> = {
keyPrefix: bytes;
(key: TKey): Box<TValue>;
}

Type Parameters

TKey
The type of the value used to key each box. This key will be encoded to bytes and prefixed with keyPrefix
TValue
The type of the data stored in the box. This value will be encoded to bytes when stored and decoded on retrieval.

BoxMap(key: TKey): Box<TValue>
Get a Box proxy for a single item in the BoxMap
Parameters
- key: TKey
  The key of the box to retrieve a proxy for
Returns Box<TValue>
- Defined in box.ts:113

Index

Properties

Properties

`Readonly`keyPrefix

keyPrefix: bytes

Get the bytes used to prefix each key