SingleBufferStoreV2

Defined in: src/backends/single_buffer/v2.ts:581

A store for version 2 of the single-buffer format.

Every change is a transaction that copies what it modifies. Readers never block, and an interrupted writer does not change the file system.

Extends

• DataView<ArrayBufferLike>

Implements

• SyncMapStore

Constructors

Constructor

new SingleBufferStoreV2(buffer, byteOffset?, byteLength?, options?): SingleBufferStore

Defined in: src/backends/single_buffer/v2.ts:616

Opens a file system, or creates one if format is set. When creating one, byte ranges in used are kept, and the first transaction runs populate after making everything else free.

Parameters

buffer

ArrayBufferLike | ArrayBufferView<ArrayBufferLike>

byteOffset?

number = 0

byteLength?

number

options?

SingleBufferStoreOptions = {}

Returns

SingleBufferStore

Overrides

DataView<ArrayBufferLike>.constructor

Properties

_fs?

protected optional _fs?: StoreFS<Store>

Defined in: src/backends/single_buffer/v2.ts:854

---

[toStringTag]

readonly [toStringTag]: string

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

Inherited from

DataView.[toStringTag]

---

blockSize

readonly blockSize: number

Defined in: src/backends/single_buffer/v2.ts:599

Internal

---

buffer

readonly buffer: ArrayBufferLike

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:1745

Inherited from

DataView.buffer

---

byteLength

readonly byteLength: number

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:1746

Inherited from

DataView.byteLength

---

byteOffset

readonly byteOffset: number

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:1747

Inherited from

DataView.byteOffset

---

bytes

readonly bytes: Uint8Array

Defined in: src/backends/single_buffer/v2.ts:596

Internal

The entire file system

---

commits

protected readonly commits: [Commit, Commit]

Defined in: src/backends/single_buffer/v2.ts:607

---

epochs

readonly epochs: EpochTable

Defined in: src/backends/single_buffer/v2.ts:602

Internal

---

flags

readonly flags: readonly ["partial"]

Defined in: src/backends/single_buffer/v2.ts:582

Use for optimizations

Implementation of

SyncMapStore.flags

---

generation

protected readonly generation: BigInt64Array

Defined in: src/backends/single_buffer/v2.ts:605

---

index

protected readonly index: BPlusTree<bigint, DataExtent>

Defined in: src/backends/single_buffer/v2.ts:610

The index of the version being read

---

mutex

protected readonly mutex: Mutex

Defined in: src/backends/single_buffer/v2.ts:604

---

name

readonly name: "sbfs" = 'sbfs'

Defined in: src/backends/single_buffer/v2.ts:583

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

Implementation of

SyncMapStore.name

---

nextId

protected readonly nextId: BigInt64Array

Defined in: src/backends/single_buffer/v2.ts:606

---

superblock

protected readonly superblock: SuperBlock

Defined in: src/backends/single_buffer/v2.ts:590

---

type

readonly type: 1935828595 = 0x73626673

Defined in: src/backends/single_buffer/v2.ts:584

See

FileSystem#id

Implementation of

SyncMapStore.type

Accessors

uuid

Get Signature

get uuid(): `${string}-${string}-${string}-${string}-${string}`

Defined in: src/backends/single_buffer/v2.ts:586

A UUID for this instance of the store.

Returns

`${string}-${string}-${string}-${string}-${string}`

A UUID for this instance of the store.

Implementation of

SyncMapStore.uuid

Methods

allocId()

allocId(): [number, number]

Defined in: src/backends/single_buffer/v2.ts:841

Allocate IDs for a new inode + data

Returns

[number, number]

Implementation of

SyncMapStore.allocId

---

delete()

delete(id): void

Defined in: src/backends/single_buffer/v2.ts:830

Parameters

id

number

Returns

void

Implementation of

SyncMapStore.delete

---

get()

get(id, offset?, end?): Uint8Array<ArrayBufferLike> | undefined

Defined in: src/backends/single_buffer/v2.ts:779

Parameters

id

number

offset?

number = 0

end?

number

Returns

Uint8Array<ArrayBufferLike> | undefined

Implementation of

SyncMapStore.get

---

getBigInt64()

getBigInt64(byteOffset, littleEndian?): bigint

Defined in: ../../node_modules/typescript/lib/lib.es2020.bigint.d.ts:732

Gets the BigInt64 value at the specified byte offset from the start of the view. There is no alignment constraint; multi-byte values may be fetched from any offset.

Parameters

byteOffset

number

The place in the buffer at which the value should be retrieved.

littleEndian?

boolean

If false or undefined, a big-endian value should be read.

Returns

bigint

Inherited from

DataView.getBigInt64

---

getBigUint64()

getBigUint64(byteOffset, littleEndian?): bigint

Defined in: ../../node_modules/typescript/lib/lib.es2020.bigint.d.ts:740

Gets the BigUint64 value at the specified byte offset from the start of the view. There is no alignment constraint; multi-byte values may be fetched from any offset.

Parameters

byteOffset

number

The place in the buffer at which the value should be retrieved.

littleEndian?

boolean

If false or undefined, a big-endian value should be read.

Returns

bigint

Inherited from

DataView.getBigUint64

---

getFloat16()

getFloat16(byteOffset, littleEndian?): number

Defined in: ../../node_modules/typescript/lib/lib.es2025.float16.d.ts:434

Gets the Float16 value at the specified byte offset from the start of the view. There is no alignment constraint; multi-byte values may be fetched from any offset.

Parameters

byteOffset

number

The place in the buffer at which the value should be retrieved.

littleEndian?

boolean

If false or undefined, a big-endian value should be read.

Returns

number

Inherited from

DataView.getFloat16

---

getFloat32()

getFloat32(byteOffset, littleEndian?): number

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:1754

Gets the Float32 value at the specified byte offset from the start of the view. There is no alignment constraint; multi-byte values may be fetched from any offset.

Parameters

byteOffset

number

The place in the buffer at which the value should be retrieved.

littleEndian?

boolean

If false or undefined, a big-endian value should be read.

Returns

number

Inherited from

DataView.getFloat32

---

getFloat64()

getFloat64(byteOffset, littleEndian?): number

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:1762

Gets the Float64 value at the specified byte offset from the start of the view. There is no alignment constraint; multi-byte values may be fetched from any offset.

Parameters

byteOffset

number

The place in the buffer at which the value should be retrieved.

littleEndian?

boolean

If false or undefined, a big-endian value should be read.

Returns

number

Inherited from

DataView.getFloat64

---

getInt16()

getInt16(byteOffset, littleEndian?): number

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:1777

Gets the Int16 value at the specified byte offset from the start of the view. There is no alignment constraint; multi-byte values may be fetched from any offset.

Parameters

byteOffset

number

The place in the buffer at which the value should be retrieved.

littleEndian?

boolean

If false or undefined, a big-endian value should be read.

Returns

number

Inherited from

DataView.getInt16

---

getInt32()

getInt32(byteOffset, littleEndian?): number

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:1784

Gets the Int32 value at the specified byte offset from the start of the view. There is no alignment constraint; multi-byte values may be fetched from any offset.

Parameters

byteOffset

number

The place in the buffer at which the value should be retrieved.

littleEndian?

boolean

If false or undefined, a big-endian value should be read.

Returns

number

Inherited from

DataView.getInt32

---

getInt8()

getInt8(byteOffset): number

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:1769

Gets the Int8 value at the specified byte offset from the start of the view. There is no alignment constraint; multi-byte values may be fetched from any offset.

Parameters

byteOffset

number

The place in the buffer at which the value should be retrieved.

Returns

number

Inherited from

DataView.getInt8

---

getUint16()

getUint16(byteOffset, littleEndian?): number

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:1799

Gets the Uint16 value at the specified byte offset from the start of the view. There is no alignment constraint; multi-byte values may be fetched from any offset.

Parameters

byteOffset

number

The place in the buffer at which the value should be retrieved.

littleEndian?

boolean

If false or undefined, a big-endian value should be read.

Returns

number

Inherited from

DataView.getUint16

---

getUint32()

getUint32(byteOffset, littleEndian?): number

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:1807

Gets the Uint32 value at the specified byte offset from the start of the view. There is no alignment constraint; multi-byte values may be fetched from any offset.

Parameters

byteOffset

number

The place in the buffer at which the value should be retrieved.

littleEndian?

boolean

If false or undefined, a big-endian value should be read.

Returns

number

Inherited from

DataView.getUint32

---

getUint8()

getUint8(byteOffset): number

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:1791

Gets the Uint8 value at the specified byte offset from the start of the view. There is no alignment constraint; multi-byte values may be fetched from any offset.

Parameters

byteOffset

number

The place in the buffer at which the value should be retrieved.

Returns

number

Inherited from

DataView.getUint8

---

keys()

keys(): number[]

Defined in: src/backends/single_buffer/v2.ts:775

Returns

number[]

Implementation of

SyncMapStore.keys

---

read()

protected read<T>(read): T

Defined in: src/backends/single_buffer/v2.ts:738

Runs read against the current version, which stays valid until read returns

Type Parameters

T

T

Parameters

read

(index) => T

Returns

T

---

set()

set(id, data, offset?): void

Defined in: src/backends/single_buffer/v2.ts:788

Parameters

id

number

data

Uint8Array

offset?

number

Returns

void

Implementation of

SyncMapStore.set

---

setBigInt64()

setBigInt64(byteOffset, value, littleEndian?): void

Defined in: ../../node_modules/typescript/lib/lib.es2020.bigint.d.ts:748

Stores a BigInt64 value at the specified byte offset from the start of the view.

Parameters

byteOffset

number

The place in the buffer at which the value should be set.

value

bigint

The value to set.

littleEndian?

boolean

If false or undefined, a big-endian value should be written.

Returns

void

Inherited from

DataView.setBigInt64

---

setBigUint64()

setBigUint64(byteOffset, value, littleEndian?): void

Defined in: ../../node_modules/typescript/lib/lib.es2020.bigint.d.ts:756

Stores a BigUint64 value at the specified byte offset from the start of the view.

Parameters

byteOffset

number

The place in the buffer at which the value should be set.

value

bigint

The value to set.

littleEndian?

boolean

If false or undefined, a big-endian value should be written.

Returns

void

Inherited from

DataView.setBigUint64

---

setFloat16()

setFloat16(byteOffset, value, littleEndian?): void

Defined in: ../../node_modules/typescript/lib/lib.es2025.float16.d.ts:442

Stores an Float16 value at the specified byte offset from the start of the view.

Parameters

byteOffset

number

The place in the buffer at which the value should be set.

value

number

The value to set.

littleEndian?

boolean

If false or undefined, a big-endian value should be written.

Returns

void

Inherited from

DataView.setFloat16

---

setFloat32()

setFloat32(byteOffset, value, littleEndian?): void

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:1815

Stores an Float32 value at the specified byte offset from the start of the view.

Parameters

byteOffset

number

The place in the buffer at which the value should be set.

value

number

The value to set.

littleEndian?

boolean

If false or undefined, a big-endian value should be written.

Returns

void

Inherited from

DataView.setFloat32

---

setFloat64()

setFloat64(byteOffset, value, littleEndian?): void

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:1823

Stores an Float64 value at the specified byte offset from the start of the view.

Parameters

byteOffset

number

The place in the buffer at which the value should be set.

value

number

The value to set.

littleEndian?

boolean

If false or undefined, a big-endian value should be written.

Returns

void

Inherited from

DataView.setFloat64

---

setInt16()

setInt16(byteOffset, value, littleEndian?): void

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:1838

Stores an Int16 value at the specified byte offset from the start of the view.

Parameters

byteOffset

number

The place in the buffer at which the value should be set.

value

number

The value to set.

littleEndian?

boolean

If false or undefined, a big-endian value should be written.

Returns

void

Inherited from

DataView.setInt16

---

setInt32()

setInt32(byteOffset, value, littleEndian?): void

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:1846

Stores an Int32 value at the specified byte offset from the start of the view.

Parameters

byteOffset

number

The place in the buffer at which the value should be set.

value

number

The value to set.

littleEndian?

boolean

If false or undefined, a big-endian value should be written.

Returns

void

Inherited from

DataView.setInt32

---

setInt8()

setInt8(byteOffset, value): void

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:1830

Stores an Int8 value at the specified byte offset from the start of the view.

Parameters

byteOffset

number

The place in the buffer at which the value should be set.

value

number

The value to set.

Returns

void

Inherited from

DataView.setInt8

---

setUint16()

setUint16(byteOffset, value, littleEndian?): void

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:1861

Stores an Uint16 value at the specified byte offset from the start of the view.

Parameters

byteOffset

number

The place in the buffer at which the value should be set.

value

number

The value to set.

littleEndian?

boolean

If false or undefined, a big-endian value should be written.

Returns

void

Inherited from

DataView.setUint16

---

setUint32()

setUint32(byteOffset, value, littleEndian?): void

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:1869

Stores an Uint32 value at the specified byte offset from the start of the view.

Parameters

byteOffset

number

The place in the buffer at which the value should be set.

value

number

The value to set.

littleEndian?

boolean

If false or undefined, a big-endian value should be written.

Returns

void

Inherited from

DataView.setUint32

---

setUint8()

setUint8(byteOffset, value): void

Defined in: ../../node_modules/typescript/lib/lib.es5.d.ts:1853

Stores an Uint8 value at the specified byte offset from the start of the view.

Parameters

byteOffset

number

The place in the buffer at which the value should be set.

value

number

The value to set.

Returns

void

Inherited from

DataView.setUint8

---

sync()

sync(): Promise<void>

Defined in: src/backends/single_buffer/v2.ts:865

Syncs the store

Returns

Promise<void>

Implementation of

SyncMapStore.sync

---

transaction()

transaction(): SyncMapTransaction

Defined in: src/backends/single_buffer/v2.ts:869

Begins a new transaction.

Returns

SyncMapTransaction

Implementation of

SyncMapStore.transaction

---

usage()

usage(): UsageInfo

Defined in: src/backends/single_buffer/v2.ts:847

Usage information for the store

Returns

UsageInfo

Implementation of

SyncMapStore.usage

---

withCurrentCommit()

protected withCurrentCommit<T>(read): T

Defined in: src/backends/single_buffer/v2.ts:729

Reads the current commit, retrying if a writer replaces it while reading

Type Parameters

T

T

Parameters

read

(commit, generation) => T

Returns

T

---

write()

write<T>(change): T

Defined in: src/backends/single_buffer/v2.ts:750

Runs change in a write transaction, retrying with more spare blocks if the free trees run out of them

Type Parameters

T

T

Parameters

change

(tx) => T

Returns

T