API reference
Auto-generated TypeScript reference for every public symbol of the `i99dash` package.
These pages are generated directly from TypeScript source in
i99dash-sdk/src/**. JSDoc on the source is the single source of truth —
if a description here is wrong, fix the source comment.
The SDK is a single package (i99dash); subpaths split by audience.
Runtime client
Host-bridge entry + 9 read-only family controllers (car, media, climate, vehicle, system, connectivity, location, nav). Imported from i99dash.
Admin client
Privileged ops — invoke admin command templates from within an admin mini-app. Imported from i99dash.
Types
Wire-shape zod schemas + types — context, manifest (incl. the network egress allow-list), all 9 family snapshot schemas. Imported from i99dash.
React bindings
Provider component + one hook per family with SSR-safe fallbacks. Imported from i99dash/react.
Dev server
Local mock host — Fastify server, bridge shim, car-status simulator. Imported from i99dash/dev-server.
CLI (programmatic)
Per-command runners (runInit, runDev, runBuild, …) for tests or custom orchestration. Imported from i99dash/cli.
Why pages can look sparse
Each API page is intentionally one line of prose plus a <AutoTypeTable />
that renders the type from source. Long-form explanation lives in
guides, which link back to the relevant API page.
How to update
- Edit the JSDoc on the symbol in
i99dash-sdk/src/**. - Rebuild:
pnpm devregenerates the table on the next request;pnpm buildregenerates statically.
Publish from CI
Wire a GitHub Actions (or any CI) pipeline that publishes your APK to i99dash on every release — push model, SSH-signed, no long-lived token stored.
Runtime client
Runtime client for mini-apps — host bridge, getContext, and the unified `client.car` controller for every car signal (climate, media, location, …). Imported from `i99dash` (root entry).