Class Store

A store-and-forward buffer.

Handing a store to a ladder consumes it, because the ladder owns it from then on. A consumed store is emptied rather than left aliasing what now belongs to the ladder, so using one twice throws.

Index

Constructors

Accessors

Methods

append len peek pop file memory

Constructors

constructor

new Store(): sync.Store

Returns sync.Store

Accessors

isAvailable

get isAvailable(): boolean
Whether this store is still holdable, or has been given to a ladder.

Returns boolean
- Defined in native/index.d.ts:1478

Methods

append

append(record: Buffer): Promise<void>
Adds a record to the end of the buffer.
Parameters
- record: Buffer
Returns Promise<void>
- Defined in native/index.d.ts:1472

len

len(): Promise<number>
How many records the buffer holds.

Returns Promise<number>
- Defined in native/index.d.ts:1480

peek

peek(): Promise<Buffer<ArrayBufferLike> | null>
Reads the oldest record without removing it, or null when empty.

Returns Promise<Buffer<ArrayBufferLike> | null>
- Defined in native/index.d.ts:1474

pop

pop(): Promise<Buffer<ArrayBufferLike> | null>
Removes and returns the oldest record, or null when empty.

Returns Promise<Buffer<ArrayBufferLike> | null>
- Defined in native/index.d.ts:1476

`Static`file

file(dir: string): sync.Store
Opens a buffer backed by a directory, so it survives a restart.
Parameters
- dir: string
  the directory to hold records in; it is created if missing.
Returns sync.Store
- Defined in native/index.d.ts:1470

`Static`memory

memory(capacity?: number | null): sync.Store
Creates a buffer held in memory.
Parameters
- Optionalcapacity: number | null
  the most records to hold, or omitted for no bound. A full store refuses the next append rather than dropping anything, so a record is never lost without the caller being told.
Returns sync.Store
- Defined in native/index.d.ts:1464