Skip to main content

Variable: FieldSchema

const FieldSchema: ObjectSchema<{
  constraints: ObjectSchema<{
     format: OptionalSchema<PicklistSchema<["email", "url", "uuid", "cuid", "cuid2", "ulid", "datetime", "date", "time", "duration", "ipv4", "ipv6"], undefined>, undefined>;
     max: OptionalSchema<NumberSchema<undefined>, undefined>;
     maxLength: OptionalSchema<NumberSchema<undefined>, undefined>;
     min: OptionalSchema<NumberSchema<undefined>, undefined>;
     minLength: OptionalSchema<NumberSchema<undefined>, undefined>;
     regex: OptionalSchema<StringSchema<undefined>, undefined>;
     unique: OptionalSchema<BooleanSchema<undefined>, undefined>;
  }, undefined>;
  dbName: OptionalSchema<StringSchema<undefined>, undefined>;
  default: OptionalSchema<VariantSchema<"kind", [ObjectSchema<{
     kind: LiteralSchema<"value", undefined>;
     value: GenericSchema<JsonValue>;
   }, undefined>, ObjectSchema<{
     args: OptionalSchema<ArraySchema<GenericSchema<JsonValue>, undefined>, undefined>;
     expr: StringSchema<undefined>;
     kind: LiteralSchema<"expr", undefined>;
  }, undefined>], undefined>, undefined>;
  doc: OptionalSchema<StringSchema<undefined>, undefined>;
  hidden: OptionalSchema<BooleanSchema<undefined>, undefined>;
  list: BooleanSchema<undefined>;
  name: StringSchema<undefined>;
  nullable: BooleanSchema<undefined>;
  optional: BooleanSchema<undefined>;
  type: GenericSchema<FieldType>;
}, undefined>;

Defined in: packages/ir/src/schemas.ts:143