Skip to content

BoxMap

@algorandfoundation/algorand-typescript


@algorandfoundation/algorand-typescript / index / BoxMap

Function: BoxMap()

BoxMap<TKey, TValue>(options): BoxMap<TKey, TValue>

Defined in: packages/algo-ts/src/box.ts:234

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

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.

Parameters

options

CreateBoxMapOptions

Options for creating the BoxMap proxy

Returns

BoxMap<TKey, TValue>