Skip to main content
Version: v10.0.0

Db


Import
import { Db } from "@hyper-fetch/db"

Preview​

type Db<Collections,Transactions> = { [ Name in keyof Collections]: HandleOf<Collections[Name]> } & DbMethods & { transaction: TransactionMethod<Collections, Transactions> };

Structure​

Db
NameTypeDescription
ready
Promise<void>

Resolves once persisted rows and the outbox are restored

transaction
TransactionMethod<Collections, Transactions>
clear
() => Promise<void>

Removes every row, loaded subset and pending write, and the persisted data of the scope, for example on sign-out

dehydrate
() => DehydratedDb

The server rows and loaded subsets, as type-tagged JSON, for server rendering. Optimistic layers, the outbox and syncs are never included. Pass it to createDb(collections, { state }) on the client.

destroy
() => void

Stops every sync, timer and tab channel

inspect
() => DbInspection

What the db holds right now: collections with their layers and subsets, live queries and the outbox

onChange
(listener: () => void) => () => void

Listens to every change the db makes, once per batch of writes, load or outbox change

onError
(listener: (event: DbErrorEvent) => void) => () => void

Listens to failed writes, rejected validation, outbox and persistence errors