Function: defineRecord()

defineRecord<T>(name, record): RecordDef<ResolvedFields<T>>

Defined in: defineRecord.ts:83

Define a record: a named set of typed fields, the basic building block of a schema.

Each field's type is a primitive (String, Double, …), a composite (Optional, Array), or a reference to another record or union — passed directly, or as () => Model for forward references.

Type Parameters

T

T extends FieldArgs

Parameters

name

string

record

RecordArgs<T>

Returns

RecordDef<ResolvedFields<T>>

Example

const ShapeBox = defineRecord("ShapeBox", {
  docs: "A box.",
  fields: { top: Double, left: Double, color: Optional(String) },
});