Reference
API reference
Generate the full TypeDoc API reference from the SDK's TSDoc comments.
The full API reference is generated from the TSDoc comments in src/ with TypeDoc. It is not committed to the repository, so build it locally:
pnpm run docs:api
The output is written to packages/core/docs/api/. Open docs/api/index.html in a browser.
Where to look first
| You need | Go to |
|---|---|
| Options of the client | Client options |
| Transport and origin settings | Transports |
| Storage adapters | Storage adapters |
| Error classes and codes | Errors |
| React provider and hooks | React and Next.js |
| Vue composables and plugin | Vue and Nuxt |