CreateClientPGliteOptions
Defined in: packages/client/src/index.ts:381
Options for createClientPGlite.
Properties
Section titled “Properties”bootAssets?
Section titled “bootAssets?”
optionalbootAssets?:Promise<PgliteBootAssets>
Defined in: packages/client/src/index.ts:387
Pre-warmed PGlite boot assets (see CreateSyncClientOptions.pgliteBootAssets). Awaited and
passed into PGlite.create; a rejected warm is caught to undefined (falls back to PGlite’s own
asset load), so it never fails the create.
restoreFrom?
Section titled “restoreFrom?”
optionalrestoreFrom?:File|Blob
Defined in: packages/client/src/index.ts:414
A store-backup tarball to seed the new store from (ADR-0035 decision 6, restore) — a File/Blob as
produced by SyncClient.exportStore. Passed straight to PGlite’s loadDataDir, so the created
store boots ON the backup’s datadir. Restore is a CREATION-path feature: the caller (createSyncClient)
has already proven the target does not yet exist (storeTargetExists); this option carries no
freshness check of its own. A corrupt/foreign tarball surfaces as a PGlite boot failure here.