Interface $ZodURLDef

interface $ZodURLDef {
    hostname?: RegExp;
    protocol?: RegExp;
    normalize?: boolean;
    type: "string";
    coerce?: boolean;
    checks?: z.core.$ZodCheck<string>[];
    error?: $ZodErrorMap<never>;
    check: "string_format";
    format: "url";
    pattern?: RegExp;
    abort?: boolean;
    when?: (payload: ParsePayload) => boolean;
}

Hierarchy (View Summary)

$ZodStringFormatDef<"url">
- $ZodURLDef

Index

Properties

hostname? protocol? normalize? type coerce? checks? error? check format pattern? abort? when?

Properties

`Optional`hostname

hostname?: RegExp

`Optional`protocol

protocol?: RegExp

`Optional`normalize

normalize?: boolean

type

type: "string"

`Optional`coerce

coerce?: boolean

`Optional`checks

checks?: z.core.$ZodCheck<string>[]

`Optional`error

error?: $ZodErrorMap<never>

check

check: "string_format"

format

format: "url"

`Optional`pattern

pattern?: RegExp

`Optional`abort

abort?: boolean

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

`Optional`when

when?: (payload: ParsePayload) => boolean

If provided, this check will only be executed if the function returns true. Defaults to payload => z.util.isAborted(payload).