Docs

Packages

@anvia/react: Overview

React hooks, event transports, and stream readers for Anvia browser clients.

What it is

React hooks, event transports, and stream readers for Anvia browser clients.

Use @anvia/react when the application needs a browser UI that consumes Anvia stream events without owning server-side model code. It provides stateful hooks for chat transcripts and single-prompt completion surfaces, plus transport helpers for JSONL, SSE, fetch, and in-process test flows.

Where it fits

@anvia/react belongs in the browser. It pairs with an application route, usually implemented with @anvia/server, that streams Anvia events.

The package owns client-side chat/completion state and event-stream transport plumbing. Keep server routes, auth, persistence, model selection, and product UI composition in application code.

Use useChat(...) for multi-turn transcripts, follow-up turns, tools, attachments, and human input. Use useCompletion(...) when the surface has one prompt input and one generated text result. Both hooks can send the same default request shape, { messages, stream: true }, but they maintain different client state.

Public surface

The main documented exports include useChat, useCompletion, createFetchTransport, createChatTransport, createDirectTransport, readJsonlStream, readSseStream, and fetchEventStream. The reference page lists the package entrypoint and public symbols that are checked by the docs reference coverage script.

Next pages