Interface Store

Represents a key-value store.

interface Store {
    name: string;
    clear(): void | Promise<void>;
    clearSync(): void;
    sync(): Promise<void>;
    transaction(): Transaction<Store>;
}

Hierarchy (view full)

Store
- SimpleSyncStore

Index

Properties

Methods

clear clearSync 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>
- Defined in src/backends/store/store.ts:22

clearSync

clearSync(): void
Empties the store completely.

Returns void
- Defined in src/backends/store/store.ts:27

sync

sync(): Promise<void>
Syncs the store

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

transaction

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

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