API reference

The pages under this section are generated with starlight-typedoc directly from each package’s source, so the API reference always matches the code. They cover the five packages you install and use directly:

• @pgxsinkit/contracts — shared Zod schemas, sync registry types, and transport DTOs.
• @pgxsinkit/pglite-opfs-repacked — constant-handle OPFS adapter, PGlite factory, validated options, and stable storage errors.
• @pgxsinkit/client — local overlay + journal, batch flush, and read wiring.
• @pgxsinkit/server — createSyncServer, the apply-function builder, and the Electric shape proxy.
• @pgxsinkit/react — React bindings over the client.

The Electric read-path ingest engine lives inside @pgxsinkit/client (src/sync/, ADR-0009) rather than a separate package, so it is not documented as its own entry — see Packages for where it fits.

New to the library? Start with Core concepts for the model, then Packages for what to install.