API Reference

Everything exported by @dcupl/core, organized by the thing you're working with. 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(), global options
Models API Define models, properties, references, and validation rules
Loader Load data from the dcupl Console or a bundled workflow
Events Lifecycle hooks — subscribe to init, update, and destroy

Data

Getting records in, out, and up to date.

Reference What lives here
Data API set, upsert, update, remove, bulk operations, partial data

Querying

The runtime query interface attached to every list.

Reference What lives here
Lists API Create, destroy, and clone lists; manage list scope
Catalog API query, fn, result access, sorting, pagination
Query operators Every operator — eq, in, contains, ranges, logic groups

Analysis functions

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

Reference What lives here
Functions API facets, aggregate, groupBy, pivot, metadata, suggest

Types

Reference What lives here
Type definitions Every TypeScript interface, generic, and discriminated union

Looking for something specific?