Loading

Reference

Introduction › Reference

  • Class & attribute options — Every field of a class document, every attribute type with its configuration keys, the class flags, and the parameters of Class.create and…
  • Trigger & job document models — The exact shape of trigger models on a class, ~Job and ~JobRun documents, the execute contract, and the one-shot job a patch may carry.
  • Scheduler options — Every option of JobScheduler.start with its default, the schedule grammar, the skip reasons a tick reports, and the shape of the per-device…
  • Sync options & status — Every option of stack.sync and docstack.sync, the status object, the handle methods and events, the schema-gate error, and the write guard.
  • Patch document format — The fields of a patch, what its docs array may contain, the one-shot job shape, the ledger entry the stack writes, and the refusals.
  • What stays on the device — The documents DocStack keeps out of replication by default, the ones it optionally replicates, and the options that widen or narrow the…
  • SQL dialect — The exact grammar the query engine accepts, token by token, and the constructs it refuses with the error you will see.
  • Server (preview) — What @docstack/server is for, the Express routes and environment variables its preview source exposes today, and why nothing is published…