@terascope/job-components / index / BigMap

Class: BigMap<K, V>

Defined in: packages/utils/dist/src/big-map.d.ts:5

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/utils/dist/src/big-map.d.ts:15

Parameters

Parameter	Type
entries?	null | readonly readonly [K, V][]

Returns

BigMap<K, V>

Properties

Property	Modifier	Type	Description	Defined in
maxMapSize	readonly	number	-	packages/utils/dist/src/big-map.d.ts:11
DEFAULT_MAX_SIZE	static	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	packages/utils/dist/src/big-map.d.ts:10

Accessors

size

Get Signature

get size(): number

Defined in: packages/utils/dist/src/big-map.d.ts:21

Returns

number

Methods

[iterator]()

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

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

Returns

IterableIterator<[K, V]>

---

clear()

clear(): void

Defined in: packages/utils/dist/src/big-map.d.ts:20

Returns

void

---

delete()

delete(key): boolean

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

Parameters

Parameter	Type
key	K

Returns

boolean

---

entries()

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

Defined in: packages/utils/dist/src/big-map.d.ts:23

Returns

IterableIterator<[K, V]>

---

forEach()

forEach(callbackFn, thisArg?): void

Defined in: packages/utils/dist/src/big-map.d.ts:22

Parameters

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

Returns

void

---

get()

get(key): undefined | V

Defined in: packages/utils/dist/src/big-map.d.ts:18

Parameters

Parameter	Type
key	K

Returns

undefined | V

---

has()

has(key): boolean

Defined in: packages/utils/dist/src/big-map.d.ts:17

Parameters

Parameter	Type
key	K

Returns

boolean

---

keys()

keys(): IterableIterator<K>

Defined in: packages/utils/dist/src/big-map.d.ts:24

Returns

IterableIterator<K>

---

set()

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

Defined in: packages/utils/dist/src/big-map.d.ts:16

Parameters

Parameter	Type
key	K
value	V

Returns

Map<K, V>

---

values()

values(): IterableIterator<V>

Defined in: packages/utils/dist/src/big-map.d.ts:25

Returns

IterableIterator<V>