Schema References
Reusable schemas and types referenced with $.
Last updated
Was this helpful?
⌘Ctrlk
Reusable schemas and types referenced with $.
A reference (ref) is a $-prefixed definition in the header that names a reusable schema or type. You define it once and refer to it elsewhere as $name. Refs come in two forms:
Schema reference — names an object shape (a SchemaDef).
Type reference — names a single constrained type (a MemberDef), e.g. a percentage.
The special ref $schema is the document's default schema.
Define an object shape once, reuse it across fields and schemas:
~ $address: { street: string, city: string }
~ $person: { name: string, home: $address, office?: $address }
~ $schema: $person
---
~ John, { Main St, NYC }, { 5th Ave, NYC }
~ Jane, { Oak Ave, LA }$schema: $person sets the default schema by reference. A ref can be used as a field's type (home: $address) or as an array's element type (tags: [$address]).
Refs are resolved after the entire header has been read, so order within the header is not significant — a ref MAY appear before the definition it targets. For readability, you SHOULD still define a ref before you use it.
A ref to a name that is never defined is an error (schema-not-defined).
Reusing a ref many times keeps a document small and consistent.
See Error Handling in Definitions for the resolution errors.
A ref whose body is a single constrained type acts as a reusable type — your own named shortcut, the document-local counterpart of built-ins like uint8 or email:
Implementation status (beta). Type references are being added. Today a top-level
$definition is compiled as an object schema (a SchemaDef), so its braces are read as an object shape — a constrained-type body such as{ number, min: 0, max: 100 }is not yet interpreted as a reusable number type. The forms above show the target syntax. Schema references (object shapes) work today.
Last updated
Was this helpful?
Was this helpful?
# A reusable "percent" type and "short text" type
~ $percent: { number, min: 0, max: 100 }
~ $shortText: { string, maxLen: 40 }
~ $schema: { name: $shortText, score: $percent }