Job Components: `Index Big Map`
index.BigMap
Avoid v8 maximum size for Map by spreading the cache across multiple Maps. This class has the same API as Map but minus more differences in ->set and ->forEach
Type parameters
Name |
---|
K |
V |
Table of contents
Constructors
Properties
Accessors
Methods
Constructors
constructor
• new BigMap<K
, V
>(entries?
): BigMap
<K
, V
>
Type parameters
Name |
---|
K |
V |
Parameters
Name | Type | |
---|---|---|
entries? | null \ | readonly readonly [K , V ][] |
Returns
BigMap
<K
, V
>
Defined in
packages/utils/dist/src/big-map.d.ts:15
Properties
maxMapSize
• Readonly
maxMapSize: number
Defined in
packages/utils/dist/src/big-map.d.ts:11
DEFAULT_MAX_SIZE
▪ Static
DEFAULT_MAX_SIZE: number
In some cache settings key evictions may not be able to keep up with the addition of new keys, setting the max size at 8.7M keys solves this issue
Defined in
packages/utils/dist/src/big-map.d.ts:10
Accessors
size
• get
size(): number
Returns
number
Defined in
packages/utils/dist/src/big-map.d.ts:21
Methods
[iterator]
▸ [iterator](): IterableIterator
<[K
, V
]>
Returns
IterableIterator
<[K
, V
]>
Defined in
packages/utils/dist/src/big-map.d.ts:26
clear
▸ clear(): void
Returns
void
Defined in
packages/utils/dist/src/big-map.d.ts:20
delete
▸ delete(key
): boolean
Parameters
Name | Type |
---|---|
key | K |
Returns
boolean
Defined in
packages/utils/dist/src/big-map.d.ts:19
entries
▸ entries(): IterableIterator
<[K
, V
]>
Returns
IterableIterator
<[K
, V
]>
Defined in
packages/utils/dist/src/big-map.d.ts:23
forEach
▸ forEach(callbackFn
, thisArg?
): void
Parameters
Name | Type |
---|---|
callbackFn | (value : V , key : K , map : BigMap <K , V >) => void |
thisArg? | unknown |
Returns
void
Defined in
packages/utils/dist/src/big-map.d.ts:22
get
▸ get(key
): undefined
| V
Parameters
Name | Type |
---|---|
key | K |
Returns
undefined
| V
Defined in
packages/utils/dist/src/big-map.d.ts:18
has
▸ has(key
): boolean
Parameters
Name | Type |
---|---|
key | K |
Returns
boolean
Defined in
packages/utils/dist/src/big-map.d.ts:17
keys
▸ keys(): IterableIterator
<K
>
Returns
IterableIterator
<K
>
Defined in
packages/utils/dist/src/big-map.d.ts:24
set
▸ set(key
, value
): Map
<K
, V
>
Parameters
Name | Type |
---|---|
key | K |
value | V |
Returns
Map
<K
, V
>
Defined in
packages/utils/dist/src/big-map.d.ts:16
values
▸ values(): IterableIterator
<V
>
Returns
IterableIterator
<V
>
Defined in
packages/utils/dist/src/big-map.d.ts:25