API-referentie
| Entrypoint | Bevat |
|---|---|
tapedb |
createClient, de query- en write-klassen, schema-builders en gedeelde types |
tapedb/schema |
schema, model, t, role, filter, check, fileCheck, attachedTo en schematypes |
tapedb/react |
useLive, useLivePage, usePresence, useBroadcast |
tapedb/worker |
defineTapeDB, Worker-types en claim-helpers |
De CLI is een commando, geen import: npx tapedb. De commando’s staan bij Installatie.
Stabiliteit
Section titled “Stabiliteit”Elk onderdeel van de API heeft een van drie statussen:
- Stabiel. Verandert alleen in een major release, behalve om een bug of beveiligingsprobleem te verhelpen. Toevoegingen (nieuwe optionele opties, exports of foutcodes) kunnen in een minor release komen. Vóór 1.0 verhoogt een brekende wijziging aan een stabiel onderdeel de minorversie en staat ze in de changelog onder “Breaking”.
- Experimenteel. Op deze pagina’s gemarkeerd met experimental. Het werkt en is getest, maar de vorm kan in een minor release veranderen, met een vermelding in de changelog. Nu:
aggregate,groupBy,$broadcastenBroadcastTopic,useBroadcast, en detopics-optie van de Worker. - Intern. Alles wat niet geëxporteerd wordt. Het kan altijd veranderen.
De HTTP-routes, het exportformaat (versie 1), de berichten op de live socket en de foutcodes horen ook bij het contract; een foutcode krijgt nooit een andere betekenis.