.md

API reference

Everything in the dcupl SDK, organized by the thing you're working with: the Dcupl and DcuplList classes from @dcupl/core, and the types from @dcupl/common. If you're new to dcupl, start with the Quick start and Core concepts first — the reference assumes you already know what models, data, and lists are.

At a glance

dcupl.ts
import { Dcupl } from '@dcupl/core';

const dcupl = new Dcupl(); // → Dcupl API
dcupl.models.set(/* ... */); // → Models API
dcupl.data.set(/* ... */); // → Data API
await dcupl.init();

const list = dcupl.lists.create(/* ... */); // → Lists API
list.catalog.query.addCondition(/* ... */); // → Catalog API
list.catalog.fn.facets(/* ... */); // → Functions API

Each block below links to the reference page for that API surface.

Setup & lifecycle

The entry point and the building blocks you configure before calling init().

Reference What lives here
Dcupl class Constructor, init(), update(), destroy(), on(), global options, and the views, scripts, loaders and quality namespaces, which are documented only on this page
Models API Define models, properties, references, and validation rules
Loader DcuplAppLoader (@dcupl/loader): load models, data and scripts from the dcupl Console or your own sources
Events dcupl.on(), list.on(), list.onResultChange() and the event types they deliver

Data

Getting records in, out, and up to date.

Reference What lives here
Data API set, update, upsert, remove, reset, apply — staged until update()

Querying

The runtime query interface attached to every list, and the global one on the instance.

Reference What lives here
Lists API Create, get, and destroy lists; scoped lists, update(), invalidate()
Catalog API query, fn, result access, sorting, pagination
Global queries dcupl.query.one/many/execute and dcupl.fn.*: query a model without creating a list
Query operators All 10 operators — eq, in, find, ranges, logic groups

Analysis functions

Everything hanging off catalog.fn for building dashboards and filter UIs.

Reference What lives here
Functions API The global dcupl.fn.* form, its query rule and errors; options and examples per function on /sdk/fn/

Types

Reference What lives here
Type definitions The SDK's TypeScript types, exported from @dcupl/common (exceptions are marked)

Looking for something specific?