Interface: FieldBuilder
Defined in: packages/ir/src/builder.ts:68
Methods
array()
array(build): this;
Defined in: packages/ir/src/builder.ts:74
Parameters
| Parameter | Type |
|---|---|
build | (element) => void |
Returns
this
dbName()
dbName(name): this;
Defined in: packages/ir/src/builder.ts:89
Parameters
| Parameter | Type |
|---|---|
name | string |
Returns
this
default()
default(d): this;
Defined in: packages/ir/src/builder.ts:87
Parameters
| Parameter | Type |
|---|---|
d | | { kind: "value"; value: JsonValue; } | { args?: JsonValue[]; expr: string; kind: "expr"; } |
Returns
this
doc()
doc(text): this;
Defined in: packages/ir/src/builder.ts:88
Parameters
| Parameter | Type |
|---|---|
text | string |
Returns
this
enum()
enum(ref): this;
Defined in: packages/ir/src/builder.ts:70
Parameters
| Parameter | Type |
|---|---|
ref | string |
Returns
this
format()
format(f): this;
Defined in: packages/ir/src/builder.ts:86
Parameters
| Parameter | Type |
|---|---|
f | | "date" | "datetime" | "uuid" | "email" | "url" | "cuid" | "cuid2" | "ulid" | "time" | "duration" | "ipv4" | "ipv6" |
Returns
this
hidden()
hidden(): this;
Defined in: packages/ir/src/builder.ts:91
Exclude the field from the entity's read shape (see Field.hidden).
Returns
this
list()
list(): this;
Defined in: packages/ir/src/builder.ts:76
Returns
this
map()
map(build): this;
Defined in: packages/ir/src/builder.ts:73
Parameters
| Parameter | Type |
|---|---|
build | (value) => void |
Returns
this
max()
max(n): this;
Defined in: packages/ir/src/builder.ts:82
Parameters
| Parameter | Type |
|---|---|
n | number |
Returns
this
maxLength()
maxLength(n): this;
Defined in: packages/ir/src/builder.ts:84
Parameters
| Parameter | Type |
|---|---|
n | number |
Returns
this
min()
min(n): this;
Defined in: packages/ir/src/builder.ts:81
Parameters
| Parameter | Type |
|---|---|
n | number |
Returns
this
minLength()
minLength(n): this;
Defined in: packages/ir/src/builder.ts:83
Parameters
| Parameter | Type |
|---|---|
n | number |
Returns
this
nullable()
nullable(): this;
Defined in: packages/ir/src/builder.ts:78
Returns
this
optional()
optional(): this;
Defined in: packages/ir/src/builder.ts:77
Returns
this
primary()
primary(): this;
Defined in: packages/ir/src/builder.ts:79
Returns
this
ref()
ref(name): this;
Defined in: packages/ir/src/builder.ts:71
Parameters
| Parameter | Type |
|---|---|
name | string |
Returns
this
regex()
regex(src): this;
Defined in: packages/ir/src/builder.ts:85
Parameters
| Parameter | Type |
|---|---|
src | string |
Returns
this
scalar()
scalar(t): this;
Defined in: packages/ir/src/builder.ts:69
Parameters
| Parameter | Type |
|---|---|
t | | "string" | "bigint" | "boolean" | "int" | "float" | "decimal" | "date" | "datetime" | "uuid" | "bytes" | "json" |
Returns
this
union()
union(build): this;
Defined in: packages/ir/src/builder.ts:72
Parameters
| Parameter | Type |
|---|---|
build | (u) => void |
Returns
this
unique()
unique(): this;
Defined in: packages/ir/src/builder.ts:80
Returns
this
unknown()
unknown(hint?): this;
Defined in: packages/ir/src/builder.ts:75
Parameters
| Parameter | Type |
|---|---|
hint? | string |
Returns
this