Interface $ZodStringFormatDef<Format>

interface $ZodStringFormatDef<
    Format extends $ZodStringFormats = $ZodStringFormats,
> {
    abort?: boolean;
    check: "string_format";
    checks?: $ZodCheck<string>[];
    coerce?: boolean;
    error?: $ZodErrorMap<never>;
    format: Format;
    pattern?: RegExp;
    type: "string";
}

Type Parameters

Format extends $ZodStringFormats = $ZodStringFormats

Hierarchy (View Summary)

$ZodStringDef
$ZodCheckStringFormatDef<Format>
- $ZodStringFormatDef
  - $ZodUUIDDef

Index

Properties

abort? check checks? coerce? error? format pattern? type

Properties

`Optional`abort

abort?: boolean

If true, no later checks will be executed if this check fails. Default false.

check

check: "string_format"

`Optional`checks

checks?: $ZodCheck<string>[]

`Optional`coerce

coerce?: boolean

`Optional`error

error?: $ZodErrorMap<never>

format

format: Format

`Optional`pattern

pattern?: RegExp

type

type: "string"