Interface $ZodCheckStringFormatDef<Format>

interface $ZodCheckStringFormatDef<
    Format extends $ZodStringFormats = $ZodStringFormats,
> {
    abort?: boolean;
    check: "string_format";
    error?: $ZodErrorMap<never>;
    format: Format;
    pattern?: RegExp;
}

Type Parameters

Format extends $ZodStringFormats = $ZodStringFormats

Hierarchy (View Summary)

$ZodCheckDef
- $ZodCheckStringFormatDef
  - $ZodCheckRegexDef
  - $ZodStringFormatDef

Index

Properties

abort? check error? format pattern?

Properties

`Optional`abort

abort?: boolean

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

check

check: "string_format"

`Optional`error

error?: $ZodErrorMap<never>

format

format: Format

`Optional`pattern

pattern?: RegExp