Reference

The API Reference is the complete, auto-generated TypeScript API surface for @agorio/sdk.

How it’s generated

The reference is produced from the SDK source by typedoc using the typedoc-plugin-markdown plugin. At build time, scripts/build-api-reference.ts:

1. Runs typedoc against the SDK’s public entry point (src/index.ts).
2. Uses the SDK’s own tsconfig.json for accurate type resolution.
3. Emits Markdown into docs/pages/reference/api/, which Nextra serves under /reference/api.

Because it’s generated from the actual exported types, the reference never drifts from the code — every class, function, interface, and type that the SDK exports appears here, with its real signatures.

The generated pages are produced during deployment and are not committed to the repository (only this section’s index and ordering are). If you’re browsing a local build, run npm run build:api inside docs/ to generate them.