API-Referenz
| Entry-Point | Enthält |
|---|---|
tapedb |
createClient, die Query- und Write-Klassen, Schema-Builder und gemeinsame Typen |
tapedb/schema |
schema, model, t, role, filter, check, fileCheck, attachedTo und Schema-Typen |
tapedb/react |
useLive, useLivePage, usePresence, useBroadcast |
tapedb/worker |
defineTapeDB, Worker-Typen und Claim-Helfer |
Die CLI ist ein Befehl, kein Import: npx tapedb. Ihre Befehle stehen unter Einrichtung.
Stabilität
Abschnitt betitelt „Stabilität“Jeder Teil der API hat einen von drei Zuständen:
- Stabil. Ändert sich nur in einem Major-Release, außer um einen Fehler oder ein Sicherheitsproblem zu beheben. Ergänzungen (neue optionale Optionen, Exporte oder Fehlercodes) können in einem Minor-Release kommen. Vor 1.0 erhöht eine inkompatible Änderung an einem stabilen Teil die Minor-Version und steht im Changelog unter „Breaking“.
- Experimentell. Auf diesen Seiten mit experimental gekennzeichnet. Es funktioniert und ist getestet, aber seine Form kann sich in einem Minor-Release ändern, mit einem Changelog-Eintrag. Derzeit:
aggregate,groupBy,$broadcastundBroadcastTopic,useBroadcastund dietopics-Option des Workers. - Intern. Alles, was nicht exportiert wird. Es kann sich jederzeit ändern.
Die HTTP-Routen, das Exportformat (Version 1), die Nachrichten des Live-Sockets und die Fehlercodes gehören ebenfalls zum Vertrag; ein Fehlercode bekommt nie eine andere Bedeutung.