Interface StringFieldOptions

Options for Schema.String() fields.

interface StringFieldOptions {
    description?: string;
    optional?: boolean;
    default?: string;
    minLength?: number;
    maxLength?: number;
    pattern?: string;
    format?: StringFormat;
}

Hierarchy (View Summary)

BaseFieldOptions
- StringFieldOptions

Index

Properties

description? optional? default? minLength? maxLength? pattern? format?

Properties

`Optional`description

description?: string

Human-readable description for documentation

`Optional`optional

optional?: boolean

Whether the field can be omitted

`Optional`default

default?: string

Default value

`Optional`minLength

minLength?: number

Minimum string length

`Optional`maxLength

maxLength?: number

Maximum string length

`Optional`pattern

pattern?: string

Regex pattern the string must match

`Optional`format

format?: StringFormat

Semantic format hint