InMemoryStore

Defined in: src/backends/memory.ts:12

A simple in-memory store

Extends

• Map<number, Uint8Array>

Implements

• SyncMapStore

Constructors

Constructor

new InMemoryStore(maxSize?, label?): InMemoryStore

Defined in: src/backends/memory.ts:17

Parameters

maxSize?

number = size_max

label?

string

Returns

InMemoryStore

Overrides

Map<number, Uint8Array>.constructor

Properties

[toStringTag]

readonly [toStringTag]: string

Defined in: ../../node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:135

Inherited from

Map.[toStringTag]

---

flags

readonly flags: readonly []

Defined in: src/backends/memory.ts:13

Use for optimizations

Implementation of

SyncMapStore.flags

---

label?

readonly optional label?: string

Defined in: src/backends/memory.ts:19

A name for this instance of the store. For example, you might use a share name for a network-based store

Implementation of

SyncMapStore.label

---

maxSize

readonly maxSize: number = size_max

Defined in: src/backends/memory.ts:18

---

name

readonly name: string = 'tmpfs'

Defined in: src/backends/memory.ts:15

What the file system using this store should be called. For example, tmpfs for an in memory store

Implementation of

SyncMapStore.name

---

size

readonly size: number

Defined in: ../../node_modules/typescript/lib/lib.es2015.collection.d.ts:46

Returns

the number of elements in the Map.

Inherited from

Map.size

---

[species]

readonly static [species]: MapConstructor

Defined in: ../../node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:317

Inherited from

Map.[species]

Accessors

bytes

Get Signature

get bytes(): number

Defined in: src/backends/memory.ts:30

Returns

number

Methods

[iterator]()

[iterator](): MapIterator<[number, Uint8Array<ArrayBufferLike>]>

Defined in: ../../node_modules/typescript/lib/lib.es2015.iterable.d.ts:141

Returns an iterable of entries in the map.

Returns

MapIterator<[number, Uint8Array<ArrayBufferLike>]>

Inherited from

Map.[iterator]

---

clear()

clear(): void

Defined in: ../../node_modules/typescript/lib/lib.es2015.collection.d.ts:21

Removes all elements from the Map.

Returns

void

Inherited from

Map.clear

---

delete()

delete(key): boolean

Defined in: ../../node_modules/typescript/lib/lib.es2015.collection.d.ts:25

Parameters

key

number

Returns

boolean

true if an element in the Map existed and has been removed, or false if the element does not exist.

Implementation of

SyncMapStore.delete

Inherited from

Map.delete

---

entries()

entries(): MapIterator<[number, Uint8Array<ArrayBufferLike>]>

Defined in: ../../node_modules/typescript/lib/lib.es2015.iterable.d.ts:146

Returns an iterable of key, value pairs for every entry in the map.

Returns

MapIterator<[number, Uint8Array<ArrayBufferLike>]>

Inherited from

Map.entries

---

forEach()

forEach(callbackfn, thisArg?): void

Defined in: ../../node_modules/typescript/lib/lib.es2015.collection.d.ts:29

Executes a provided function once per each key/value pair in the Map, in insertion order.

Parameters

callbackfn

(value, key, map) => void

thisArg?

any

Returns

void

Inherited from

Map.forEach

---

get()

get(key): Uint8Array<ArrayBufferLike> | undefined

Defined in: ../../node_modules/typescript/lib/lib.es2015.collection.d.ts:34

Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.

Parameters

key

number

Returns

Uint8Array<ArrayBufferLike> | undefined

Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.

Implementation of

SyncMapStore.get

Inherited from

Map.get

---

getOrInsert()

getOrInsert(key, defaultValue): Uint8Array

Defined in: ../../node_modules/typescript/lib/lib.esnext.collection.d.ts:25

Returns a specified element from the Map object. If no element is associated with the specified key, a new element with the value defaultValue will be inserted into the Map and returned.

Parameters

key

number

defaultValue

Uint8Array

Returns

Uint8Array

The element associated with the specified key, which will be defaultValue if no element previously existed.

Inherited from

Map.getOrInsert

---

getOrInsertComputed()

getOrInsertComputed(key, callback): Uint8Array

Defined in: ../../node_modules/typescript/lib/lib.esnext.collection.d.ts:31

Returns a specified element from the Map object. If no element is associated with the specified key, the result of passing the specified key to the callback function will be inserted into the Map and returned.

Parameters

key

number

callback

(key) => Uint8Array

Returns

Uint8Array

The element associated with the specific key, which will be the newly computed value if no element previously existed.

Inherited from

Map.getOrInsertComputed

---

has()

has(key): boolean

Defined in: ../../node_modules/typescript/lib/lib.es2015.collection.d.ts:38

Parameters

key

number

Returns

boolean

boolean indicating whether an element with the specified key exists or not.

Inherited from

Map.has

---

keys()

keys(): MapIterator<number>

Defined in: ../../node_modules/typescript/lib/lib.es2015.iterable.d.ts:151

Returns an iterable of keys in the map

Returns

MapIterator<number>

Implementation of

SyncMapStore.keys

Inherited from

Map.keys

---

set()

set(key, value): this

Defined in: ../../node_modules/typescript/lib/lib.es2015.collection.d.ts:42

Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated.

Parameters

key

number

value

Uint8Array

Returns

this

Implementation of

SyncMapStore.set

Inherited from

Map.set

---

sync()

sync(): Promise<void>

Defined in: src/backends/memory.ts:24

Syncs the store

Returns

Promise<void>

Implementation of

SyncMapStore.sync

---

transaction()

transaction(): SyncMapTransaction

Defined in: src/backends/memory.ts:26

Begins a new transaction.

Returns

SyncMapTransaction

Implementation of

SyncMapStore.transaction

---

usage()

usage(): UsageInfo

Defined in: src/backends/memory.ts:36

Usage information for the store

Returns

UsageInfo

Implementation of

SyncMapStore.usage

---

values()

values(): MapIterator<Uint8Array<ArrayBufferLike>>

Defined in: ../../node_modules/typescript/lib/lib.es2015.iterable.d.ts:156

Returns an iterable of values in the map

Returns

MapIterator<Uint8Array<ArrayBufferLike>>

Inherited from

Map.values

---

groupBy()

static groupBy<K, T>(items, keySelector): Map<K, T[]>

Defined in: ../../node_modules/typescript/lib/lib.es2024.collection.d.ts:23

Groups members of an iterable according to the return value of the passed callback.

Type Parameters

K

K

T

T

Parameters

items

Iterable<T>

An iterable.

keySelector

(item, index) => K

A callback which will be invoked for each item in items.

Returns

Map<K, T[]>

Inherited from

Map.groupBy