createDb
Creates the db that queries and writes go through. The names given to it are the names on the db, as in
db.post
.
Requests carry their Client and listeners carry their Socket, so it needs neither.
import { createDb } from "@hyper-fetch/db"
Usage
const db = createDb({ post: Post, user: User });
Parameters
createDb<Collections, Transactions>(collections: Collections & { [ Name in (onError | ready | clear | destroy | transaction | dehydrate | inspect | onChange)]: never }, options: Notation & { codecs?: readonly DbCodec[]; gcTime?: number; offline?: (boolean | DbOfflineOptions); persistence?: DbPersistenceOptions; state?: DehydratedDb; syncTimeout?: number; tabs?: (false | { channel?: DbChannel; locks?: DbLockManager }) } & { links?: readonly readonly [(keyof Collections & string), (keyof Collections & string)][]; transactions?: (Transactions & Record<string, TransactionConfig>) })
| Name | Type | Description |
|---|---|---|
| collections | | |
| options | |
Returns
type Db<Collections,Transactions> = { [ Name in keyof Collections]: HandleOf<Collections[Name]> } & DbMethods & { transaction: TransactionMethod<Collections, Transactions> };
| Name | Type | Description |
|---|---|---|
| ready | | Resolves once persisted rows and the outbox are restored |
| transaction | | |
| clear | | Removes every row, loaded subset and pending write, and the persisted data of the scope, for example on sign-out |
| dehydrate | | 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
|
| destroy | | Stops every sync, timer and tab channel |
| inspect | | What the db holds right now: collections with their layers and subsets, live queries and the outbox |
| onChange | | Listens to every change the db makes, once per batch of writes, load or outbox change |
| onError | | Listens to failed writes, rejected validation, outbox and persistence errors |
