Skip to main content

@terascope/core-utils / big-map / BigMap

Class: BigMap<K, V>

Defined in: packages/core-utils/src/big-map.ts:7

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​

Type Parameter
K
V

Constructors​

Constructor​

new BigMap<K, V>(entries?): BigMap<K, V>

Defined in: packages/core-utils/src/big-map.ts:19

Parameters​

ParameterType
entries?readonly readonly [K, V][] | null

Returns​

BigMap<K, V>

Properties​

PropertyModifierTypeDescriptionDefined in
maxMapSizereadonlynumber-packages/core-utils/src/big-map.ts:14
DEFAULT_MAX_SIZEstaticnumberIn 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 issuepackages/core-utils/src/big-map.ts:12

Accessors​

size​

Get Signature​

get size(): number

Defined in: packages/core-utils/src/big-map.ts:76

Returns​

number

Methods​

[iterator]()​

[iterator](): IterableIterator<[K, V]>

Defined in: packages/core-utils/src/big-map.ts:123

Returns​

IterableIterator<[K, V]>


clear()​

clear(): void

Defined in: packages/core-utils/src/big-map.ts:63

Returns​

void


delete()​

delete(key): boolean

Defined in: packages/core-utils/src/big-map.ts:50

Parameters​

ParameterType
keyK

Returns​

boolean


entries()​

entries(): IterableIterator<[K, V]>

Defined in: packages/core-utils/src/big-map.ts:102

Returns​

IterableIterator<[K, V]>


forEach()​

forEach(callbackFn, thisArg?): void

Defined in: packages/core-utils/src/big-map.ts:90

Parameters​

ParameterType
callbackFn(value, key, map) => void
thisArg?unknown

Returns​

void


get()​

get(key): V | undefined

Defined in: packages/core-utils/src/big-map.ts:43

Parameters​

ParameterType
keyK

Returns​

V | undefined


has()​

has(key): boolean

Defined in: packages/core-utils/src/big-map.ts:36

Parameters​

ParameterType
keyK

Returns​

boolean


keys()​

keys(): IterableIterator<K>

Defined in: packages/core-utils/src/big-map.ts:109

Returns​

IterableIterator<K>


set()​

set(key, value): Map<K, V>

Defined in: packages/core-utils/src/big-map.ts:26

Parameters​

ParameterType
keyK
valueV

Returns​

Map<K, V>


values()​

values(): IterableIterator<V>

Defined in: packages/core-utils/src/big-map.ts:116

Returns​

IterableIterator<V>