Client guides

These guides cover the browser-neutral @pbvex/client client. For framework bindings, see the React guides and Svelte guides.

Topics

• Installation — packages and environment requirements.
• Configuration — base URL, fetch injection, timeouts, auth, and limits.
• Queries, mutations, and actions — typed and string-based calls, optional args, call options, cancellation.
• Realtime subscriptions — watch lifecycle, connection state, retry behavior, cleanup, max event handling.
• Errors and troubleshooting — PBVexError, error codes, timeout, cancellation, and diagnostics.

Core concepts

• Generated API references live in pbvex/_generated/api.ts and are imported as FunctionReference objects.
• Client is the single entry point for HTTP calls and SSE realtime subscriptions.
• PBVexClient is a compatibility subclass of Client.
• All calls are Promise-based and use AbortSignal for cancellation.

Cross-links

• Server-side authoring is documented in the core guides: Authoring functions, Schema and data model, Authentication, Storage.
• Protocol details are in the Protocol v1 ADR.
• Running the backend is covered in the self-hosting guide.