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(id: bigint): void;
    get(id: bigint): undefined | Uint8Array;
    keys(): Iterable<bigint>;
    set(id: bigint, data: Uint8Array): void;
    sync(): Promise<void>;
    transaction(): Transaction<Store>;
}

Hierarchy (view full)

Store
- SimpleSyncStore

Implemented by

Index

Properties

Methods

clear clearSync delete get keys 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:21

clearSync

clearSync(): void
Empties the store completely.

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

delete

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

get

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

keys

keys(): Iterable<bigint>
Returns Iterable<bigint>
- Defined in src/backends/store/simple.ts:7

set

set(id, data): void
Parameters
- id: 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:16

transaction

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

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