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 eight packages you install and use directly:

• @pgxsinkit/contracts — shared Zod schemas, sync registry types, and transport DTOs.
• @pgxsinkit/client — local overlay + journal, batch flush, and read wiring.
• @pgxsinkit/server — createSyncServer, the apply-function builder, and the read path’s control plane + stream edge.
• @pgxsinkit/react — React bindings over the client.
• @pgxsinkit/pgwasm — the Postgres runtime: createPgwasm, /live, /drizzle, /protocol, the OPFS-repacked store (/opfs), and the /fs and /build contracts.
• @pgxsinkit/pgwasm-c — the C Postgres build, /prepopulated, and /contrib/amcheck.
• @pgxsinkit/pgwasm-pg-dump — pgDump and its errors.
• @pgxsinkit/pgwasm-repl — the <Repl> component.

The read-path reader, its transport included, lives inside @pgxsinkit/client (src/circuits/, ADR-0055), rather than in 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.