To define and use data models in your project, create a directory named "📦" in the root
of your project. This directory will contain
.yaml files that
define the model names and fields, as well as the structure of
The file name indicates both the name of the model as well as the model's type. The model's type is denoted with a specific emoji prefix.
- Universal — prefix file with 🌐
- Content — prefix file with 📄
- User Profile — prefix file with 👤
- Embedded — prefix file with 📎
To define model types that are in a container, place them into a directory named after the container type.
/📦/🌐List.yaml /📦/List/🌐Note.yaml /📦/List/🌐Task.yaml
Field names must follow camel case, e.g. "camel" or "camelCase". All defined fields are indexed and required by default. Field definitions have a short form and long form, which may be mixed and matched as needed in the same file. .yaml files use spaces, not tabs, for indentation.
To compactly use all defaults for a field, simply assign a field type immediately following the field name (all fields are required by default).
fieldName: string otherField: boolean
Short form field definitions may be configured as
optional with the '?' postfix:
To define additional field properties use the long form:
fieldName: type: string optional: true unique: true otherField: type: boolean
Global embedded values may be referenced as any other field type:
Local embedded values have field definitions inlined beneath the
contact: type: first: string last: string email: string
This local embedded model type is ultimately accessed as:
order.contact = new Order.Contact().email('firstname.lastname@example.org')
Custom ID Prefixes
Models always have an automatically generated unique
A custom prefix may be added to all generated IDs for a particular model type.
This prefix may be between 1-3 lowercase alpha characters (a-z), and optionally end with an underscore.
🎛: prefix: prd_ # Field definitions
This will produce IDs for the
Product model such as