Interface SimpleSyncStore

An interface for simple synchronous stores that don't have special support for transactions and such.

interface SimpleSyncStore {
    name: string;
    clear(): void | Promise<void>;
    clearSync(): void;
    delete(ino): void;
    get(ino): undefined | Uint8Array;
    set(ino, data): void;
    sync(): Promise<void>;
    transaction(): Transaction<Store>;
}

Hierarchy (view full)

Store
- SimpleSyncStore

Implemented by

Index

Properties

Methods

clear clearSync delete get set sync transaction

Properties

`Readonly` name

name: string

The name of the store.

Methods

clear

clear(): void | Promise<void>
Empties the store completely.

Returns void | Promise<void>
Inherited from Store.clear
- Defined in src/backends/store/store.ts:22

clearSync

clearSync(): void
Empties the store completely.

Returns void
Inherited from Store.clearSync
- Defined in src/backends/store/store.ts:27

delete

delete(ino): void
Parameters
- ino: bigint
Returns void
- Defined in src/backends/store/simple.ts:10

get

get(ino): undefined | Uint8Array
Parameters
- ino: bigint
Returns undefined | Uint8Array
- Defined in src/backends/store/simple.ts:8

set

set(ino, data): void
Parameters
- ino: bigint
- data: Uint8Array
Returns void
- Defined in src/backends/store/simple.ts:9

sync

sync(): Promise<void>
Syncs the store

Returns Promise<void>
Inherited from Store.sync
- Defined in src/backends/store/store.ts:17

transaction

transaction(): Transaction<Store>
Begins a new transaction.

Returns Transaction<Store>
Inherited from Store.transaction
- Defined in src/backends/store/store.ts:32