BoxMap
Algorand TypeScript / index / BoxMap
BoxMap<
TKey,TValue> =Box<TValue>
Defined in: box.ts:151
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
Options for creating the BoxMap proxy
Type Parameters
Section titled “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
Section titled “TValue”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):Box<TValue>
Defined in: box.ts:113
Get a Box proxy for a single item in the BoxMap
Parameters
Section titled “Parameters”TKey
The key of the box to retrieve a proxy for
Returns
Section titled “Returns”Box<TValue>
Properties
Section titled “Properties”keyPrefix
Section titled “keyPrefix”
readonlykeyPrefix:bytes
Defined in: box.ts:107
Get the bytes used to prefix each key