API reference
| Entry point | Contains |
|---|---|
tapedb |
createClient, the query and write classes, schema builders and shared types |
tapedb/schema |
schema, model, t, role, filter, check, fileCheck, attachedTo and schema types |
tapedb/react |
useLive, useLivePage, usePresence, useBroadcast |
tapedb/worker |
defineTapeDB, Worker types and claim helpers |
The CLI is a command, not an import: npx tapedb. Its commands are on Setup.
Stability
Section titled “Stability”Every part of the API is in one of three states:
- Stable. Changes only in a major release, except to fix a bug or a security problem. Additions (new optional options, exports or error codes) may arrive in a minor release. Before 1.0, a breaking change to a stable part bumps the minor version and is listed in the changelog under “Breaking”.
- Experimental. Marked experimental on these pages. It works and is tested, but its shape may change in a minor release, with a changelog entry. Today:
aggregate,groupBy,$broadcastandBroadcastTopic,useBroadcast, and the Worker’stopicsoption. - Internal. Everything not exported. It may change at any time.
The HTTP routes, the export format (version 1), the live socket messages and the error codes are part of the contract too; error codes are never repurposed.