Relatude Help

TypeScript packages

Member Package What it is for
db.createStore, db.RelatudeStore, db.StoreTransaction @relatude/sdk the NodeStore over the CMS API, and its transactions
db.TokenSession, db.RelatudeChannel, db.CommandError @relatude/sdk sign-in tokens, the command channel and event stream, and a failed command
db.nodeType, db.Node, db.One, db.Many, db.Ref, db.Refs, db.Decimal, db.FileValue @relatude/sdk a model described in TypeScript, and the nodes read with it
db.NodeQuery, db.and, db.or, db.not, db.raw @relatude/sdk the query builder
definePlugin, useCms, CmsApi, DataClient, SDK_VERSION @relatude/sdk a plugin, and the CMS services it gets
Blade, Button, Field, Table, Icon, … @relatude/ui the components plugins draw with
relatudePlugin() @relatude/plugin-kit the Vite build of a plugin
relatude-plugin dev, dev() @relatude/plugin-kit rebuilds a plugin as it changes and serves it to a CMS opened with ?plugin=
npm create @relatude/plugin @relatude/create-plugin a new plugin from the starter