Interface SqliteOpfsOptions

Options for the sqlite-over-OPFS adapter.

interface SqliteOpfsOptions {
    connect?: () => Promise<SqliteFiles>;
    filename?: string;
    locks?: LockManagerLike;
    storage?: FilenameStorage;
    onRecover?(event: CacheRecoveryEvent): void;
}

Index

Properties

connect? filename? locks? storage?

Methods

Properties

`Optional` `Readonly`connect

connect?: () => Promise<SqliteFiles>

Opens the database files. Default: a dedicated worker running sqlite-wasm over the OPFS SAH pool.

`Optional` `Readonly`filename

filename?: string

The database file in the SAH pool. Default /kernl-events.sqlite3.

`Optional` `Readonly`locks

locks?: LockManagerLike

Guards the database against a second tab. Default navigator.locks when there is one.

`Optional` `Readonly`storage

storage?: FilenameStorage

Keeps the filename after a rotation. Default globalThis.localStorage when there is one.

Methods

`Optional`onRecover

onRecover?(event: CacheRecoveryEvent): void
Told whenever a damaged database was wiped or rotated, or the cache gave up.
Parameters
- event: CacheRecoveryEvent
Returns void