Class SingleBufferStore

Hierarchy

BufferView
- SingleBufferStore

Implements

SyncMapStore

Index

Constructors

constructor

new SingleBufferStore(
    ...args: [
        _buffer?: | number
        | ArrayBufferLike
        | ArrayBufferView<ArrayBufferLike>
        | ArrayLike<number>,
        _byteOffset?: number,
        _byteLength?: number,
    ],
): SingleBufferStore
Parameters
- ...args: [
      _buffer?: | number
      | ArrayBufferLike
      | ArrayBufferView<ArrayBufferLike>
      | ArrayLike<number>,
      _byteOffset?: number,
      _byteLength?: number,
  ]
Returns SingleBufferStore
Overrides BufferView.constructor
- Defined in src/backends/single_buffer.ts:336

Properties

`Protected` `Optional`_fs

_fs?: StoreFS<Store>

`Protected` `Readonly`_u8

_u8: Uint8Array

`Readonly`[toStringTag]

"[toStringTag]": string

`Readonly`buffer

buffer: ArrayBufferLike

`Readonly`byteLength

byteLength: number

`Readonly`byteOffset

byteOffset: number

`Readonly`flags

flags: readonly [] = ...

Use for optimizations

`Readonly`name

name: "sbfs" = 'sbfs'

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

`Protected`superblock

superblock: SuperBlock

`Readonly`type

type: 1935828595 = 0x73626673

See

FileSystem#id

Accessors

uuid

get uuid(): `${string}-${string}-${string}-${string}-${string}`
A UUID for this instance of the store.

Returns `${string}-${string}-${string}-${string}-${string}`
Implementation of SyncMapStore.uuid
- Defined in src/backends/single_buffer.ts:323

Methods

delete

delete(id: number): void
Parameters
- id: number
Returns void
Implementation of SyncMapStore.delete
- Defined in src/backends/single_buffer.ts:424

get

get(id: number): undefined | Uint8Array<ArrayBufferLike>
Parameters
- id: number
Returns undefined | Uint8Array<ArrayBufferLike>
Implementation of SyncMapStore.get
- Defined in src/backends/single_buffer.ts:359

getBigInt64

getBigInt64(byteOffset: number, littleEndian?: boolean): bigint
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.
- OptionallittleEndian: boolean
  If false or undefined, a big-endian value should be read.
Returns bigint
Inherited from BufferView.getBigInt64
- Defined in node_modules/typescript/lib/lib.es2020.bigint.d.ts:734

getBigUint64

getBigUint64(byteOffset: number, littleEndian?: boolean): bigint
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.
- OptionallittleEndian: boolean
  If false or undefined, a big-endian value should be read.
Returns bigint
Inherited from BufferView.getBigUint64
- Defined in node_modules/typescript/lib/lib.es2020.bigint.d.ts:742

getFloat16

getFloat16(byteOffset: number, littleEndian?: boolean): number
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.
- OptionallittleEndian: boolean
  If false or undefined, a big-endian value should be read.
Returns number
Inherited from BufferView.getFloat16
- Defined in node_modules/typescript/lib/lib.esnext.float16.d.ts:434

getFloat32

getFloat32(byteOffset: number, littleEndian?: boolean): number
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.
- OptionallittleEndian: boolean
  If false or undefined, a big-endian value should be read.
Returns number
Inherited from BufferView.getFloat32
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1749

getFloat64

getFloat64(byteOffset: number, littleEndian?: boolean): number
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.
- OptionallittleEndian: boolean
  If false or undefined, a big-endian value should be read.
Returns number
Inherited from BufferView.getFloat64
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1757

getInt16

getInt16(byteOffset: number, littleEndian?: boolean): number
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.
- OptionallittleEndian: boolean
  If false or undefined, a big-endian value should be read.
Returns number
Inherited from BufferView.getInt16
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1772

getInt32

getInt32(byteOffset: number, littleEndian?: boolean): number
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.
- OptionallittleEndian: boolean
  If false or undefined, a big-endian value should be read.
Returns number
Inherited from BufferView.getInt32
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1779

getInt8

getInt8(byteOffset: number): number
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 BufferView.getInt8
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1764

getUint16

getUint16(byteOffset: number, littleEndian?: boolean): number
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.
- OptionallittleEndian: boolean
  If false or undefined, a big-endian value should be read.
Returns number
Inherited from BufferView.getUint16
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1794

getUint32

getUint32(byteOffset: number, littleEndian?: boolean): number
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.
- OptionallittleEndian: boolean
  If false or undefined, a big-endian value should be read.
Returns number
Inherited from BufferView.getUint32
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1802

getUint8

getUint8(byteOffset: number): number
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 BufferView.getUint8
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1786

keys

keys(): Iterable<number>
Returns Iterable<number>
Implementation of SyncMapStore.keys
- Defined in src/backends/single_buffer.ts:347

set

set(id: number, data: Uint8Array): void
Parameters
- id: number
- data: Uint8Array
Returns void
Implementation of SyncMapStore.set
- Defined in src/backends/single_buffer.ts:370

setBigInt64

setBigInt64(byteOffset: number, value: bigint, littleEndian?: boolean): void
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.
- OptionallittleEndian: boolean
  If false or undefined, a big-endian value should be written.
Returns void
Inherited from BufferView.setBigInt64
- Defined in node_modules/typescript/lib/lib.es2020.bigint.d.ts:750

setBigUint64

setBigUint64(byteOffset: number, value: bigint, littleEndian?: boolean): void
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.
- OptionallittleEndian: boolean
  If false or undefined, a big-endian value should be written.
Returns void
Inherited from BufferView.setBigUint64
- Defined in node_modules/typescript/lib/lib.es2020.bigint.d.ts:758

setFloat16

setFloat16(byteOffset: number, value: number, littleEndian?: boolean): void
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.
- OptionallittleEndian: boolean
  If false or undefined, a big-endian value should be written.
Returns void
Inherited from BufferView.setFloat16
- Defined in node_modules/typescript/lib/lib.esnext.float16.d.ts:442

setFloat32

setFloat32(byteOffset: number, value: number, littleEndian?: boolean): void
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.
- OptionallittleEndian: boolean
  If false or undefined, a big-endian value should be written.
Returns void
Inherited from BufferView.setFloat32
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1810

setFloat64

setFloat64(byteOffset: number, value: number, littleEndian?: boolean): void
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.
- OptionallittleEndian: boolean
  If false or undefined, a big-endian value should be written.
Returns void
Inherited from BufferView.setFloat64
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1818

setInt16

setInt16(byteOffset: number, value: number, littleEndian?: boolean): void
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.
- OptionallittleEndian: boolean
  If false or undefined, a big-endian value should be written.
Returns void
Inherited from BufferView.setInt16
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1833

setInt32

setInt32(byteOffset: number, value: number, littleEndian?: boolean): void
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.
- OptionallittleEndian: boolean
  If false or undefined, a big-endian value should be written.
Returns void
Inherited from BufferView.setInt32
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1841

setInt8

setInt8(byteOffset: number, value: number): void
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 BufferView.setInt8
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1825

setUint16

setUint16(byteOffset: number, value: number, littleEndian?: boolean): void
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.
- OptionallittleEndian: boolean
  If false or undefined, a big-endian value should be written.
Returns void
Inherited from BufferView.setUint16
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1856

setUint32

setUint32(byteOffset: number, value: number, littleEndian?: boolean): void
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.
- OptionallittleEndian: boolean
  If false or undefined, a big-endian value should be written.
Returns void
Inherited from BufferView.setUint32
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1864

setUint8

setUint8(byteOffset: number, value: number): void
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 BufferView.setUint8
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1848

sync

sync(): Promise<void>
Syncs the store

Returns Promise<void>
Implementation of SyncMapStore.sync
- Defined in src/backends/single_buffer.ts:449

transaction

transaction(): SyncMapTransaction
Begins a new transaction.

Returns SyncMapTransaction
Implementation of SyncMapStore.transaction
- Defined in src/backends/single_buffer.ts:460

usage

usage(): UsageInfo
Usage information for the store

Returns UsageInfo
Implementation of SyncMapStore.usage
- Defined in src/backends/single_buffer.ts:453

Class SingleBufferStore

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SingleBufferStore

Properties

Protected Optional_fs

Protected Readonly_u8

Readonly[toStringTag]

Readonlybuffer

ReadonlybyteLength

ReadonlybyteOffset

Readonlyflags

Readonlyname

Protectedsuperblock

Readonlytype

See

Accessors

uuid

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

Methods

delete

Parameters

Returns void

get

Parameters

Returns undefined | Uint8Array<ArrayBufferLike>

getBigInt64

Parameters

Returns bigint

getBigUint64

Parameters

Returns bigint

getFloat16

Parameters

Returns number

getFloat32

Parameters

Returns number

getFloat64

Parameters

Returns number

getInt16

Parameters

Returns number

getInt32

Parameters

Returns number

getInt8

Parameters

Returns number

getUint16

Parameters

Returns number

getUint32

Parameters

Returns number

getUint8

Parameters

Returns number

keys

Returns Iterable<number>

set

Parameters

Returns void

setBigInt64

Parameters

Returns void

setBigUint64

Parameters

Returns void

setFloat16

Parameters

`Protected` `Optional`_fs

`Protected` `Readonly`_u8

`Readonly`[toStringTag]

`Readonly`buffer

`Readonly`byteLength

`Readonly`byteOffset

`Readonly`flags

`Readonly`name

`Protected`superblock

`Readonly`type