Skip to main content

Function: formInitExpr()

function formInitExpr(field, enumZero?): string;

Defined in: packages/ir/src/helpers.ts:372

A form field's initial-value expression, as source text: a literal default, [] for a list / array, null for a nullable field, else the type's zero ('', 0, false, 0n, new Date(0), {}, the enum's first member). A ref / non-discriminated union field has no synthesisable zero and yields undefined; a generator whose form model cannot hold undefined overrides that case itself. enumZero resolves an enum ref to its first member name.

Parameters​

ParameterTypeDescription
field{ constraints: { format?: | "date" | "datetime" | "uuid" | "email" | "url" | "cuid" | "cuid2" | "ulid" | "time" | "duration" | "ipv4" | "ipv6"; max?: number; maxLength?: number; min?: number; minLength?: number; regex?: string; unique?: boolean; }; dbName?: string; default?: | { kind: "value"; value: JsonValue; } | { args?: JsonValue[]; expr: string; kind: "expr"; }; doc?: string; hidden?: boolean; list: boolean; name: string; nullable: boolean; optional: boolean; type: FieldType; }-
field.constraints{ format?: | "date" | "datetime" | "uuid" | "email" | "url" | "cuid" | "cuid2" | "ulid" | "time" | "duration" | "ipv4" | "ipv6"; max?: number; maxLength?: number; min?: number; minLength?: number; regex?: string; unique?: boolean; }-
field.constraints.format?| "date" | "datetime" | "uuid" | "email" | "url" | "cuid" | "cuid2" | "ulid" | "time" | "duration" | "ipv4" | "ipv6"-
field.constraints.max?number-
field.constraints.maxLength?number-
field.constraints.min?number-
field.constraints.minLength?number-
field.constraints.regex?string-
field.constraints.unique?boolean-
field.dbName?string-
field.default?| { kind: "value"; value: JsonValue; } | { args?: JsonValue[]; expr: string; kind: "expr"; }-
field.doc?string-
field.hidden?booleanExcluded from the read shape (Read variant) of the entity: a field the source marks as never to leave the server, such as a password hash.
field.list?boolean-
field.name?string-
field.nullable?boolean-
field.optional?boolean-
field.type?FieldType-
enumZero?EnumZero-

Returns​

string