Class S2MMapStore<V>

NOTE: The File KVStore is designed to be used in states:

write-only. The initial state is write-only. Write all you need to before reading
read-only. Once you have written everything, the first read will lock the file to be static and read-only.

Type Parameters

V = Properties | Value | VectorKey

Index

Constructors

Accessors

Methods

close entries get has set sort

Constructors

constructor

new S2MMapStore<V = Value | Properties | VectorKey>(
fileName?: string,
options?: MMapOptions,
): S2MMapStore<V>
Builds a new File based KV
Type Parameters
- V = Value | Properties | VectorKey
Parameters
- OptionalfileName: string
  the path + file name without the extension
- Optionaloptions: MMapOptions
  the options of how the store should be created and ued
Returns S2MMapStore<V>

Accessors

length

get length(): number
Returns number
- the length of the store

Methods

close

close(cleanup?: boolean): void
Closes the store
Parameters
- cleanup: boolean = false
  set to true if you want to remove the .keys and .values files upon closing
Returns void

entries

entries(bigint?: boolean): AsyncIterableIterator<MMapEntry<V>>
Iterates over all values in the store
Parameters
- bigint: boolean = false
  set to true if the value is a bigint stored in the index
Returns AsyncIterableIterator<MMapEntry<V>>
Yields
an iterator

get

get(
    key: number | bigint,
    max?: number,
    bigint?: boolean,
): Promise<undefined | V[]>
Gets the value associated with a key
Parameters
- key: number | bigint
  the key
- Optionalmax: number
  the max number of values to return
- bigint: boolean = false
  set to true if the key is a bigint
Returns Promise<undefined | V[]>
the value if the map contains values for the key

has

has(key: number | bigint): Promise<boolean>
Checks if the store contains a key
Parameters
- key: number | bigint
  the key
Returns Promise<boolean>
true if the store contains the key

set

set(key: number | bigint, value: V): void
Adds a value to be associated with a key
Parameters
- key: number | bigint
  the uint64 id
- value: V
  the value to store
Returns void

sort

sort(): Promise<void>
Sort the data if not sorted

Returns Promise<void>