Class: FieldDef

Defined in: packages/core/src/model/defineModel.ts:55

A field definition descriptor — chainable for .default(), .alias(), .examples()

Constructors

Constructor

new FieldDef(
   type, 
   label?, 
   options?): FieldDef;

Defined in: packages/core/src/model/defineModel.ts:64

Parameters

Parameter	Type
type	FieldType
label?	string
options?	{ enumValues?: readonly [string, string]; shape?: Record<string, FieldDef>; }
options.enumValues?	readonly [string, string]
options.shape?	Record<string, FieldDef>

Returns

FieldDef

Methods

alias()

alias(name): this;

Defined in: packages/core/src/model/defineModel.ts:85

Set an alias name (Pydantic-inspired Field(alias=))

Parameters

Parameter	Type
name	string

Returns

this

---

default()

default(value): this;

Defined in: packages/core/src/model/defineModel.ts:79

Set a default value (Prisma-inspired @default())

Parameters

Parameter	Type
value	unknown

Returns

this

---

examples()

examples(values): this;

Defined in: packages/core/src/model/defineModel.ts:91

Set example values (Pydantic-inspired Field(examples=[]))

Parameters

Parameter	Type
values	unknown[]

Returns

this