Skip to content

StoreExportOptions

Defined in: packages/client/src/export-store.ts:25

Options for SyncClient.exportStore.

optional compression?: "none" | "gzip" | "auto"

Defined in: packages/client/src/export-store.ts:32

How to compress the tarball, forwarded to PGlite’s dumpDataDir. "auto" (the default) gzips when a CompressionStream is available and falls back to an uncompressed tar otherwise; "gzip" forces compression; "none" skips it. The report’s compression records the compression that was actually applied (which, under "auto", is resolved at runtime).


optional fileName?: string

Defined in: packages/client/src/export-store.ts:38

Override the generated artefact file name. When omitted, the name is <storeId>-<timestamp>.pgdata.tar[.gz], where storeId is a filesystem-safe derivation of the store path and the extension reflects the applied compression.