Interface ZodString

interface ZodString {
    def: $ZodStringDef;
    type: "string";
    _def: $ZodStringDef;
    _output: string;
    _input: string;
    check(...checks: ($ZodCheck<string> | CheckFn<string>)[]): this;
    clone(def?: $ZodStringDef, params?: { parent: boolean }): this;
    register<
        R extends
            $ZodRegistry<
                MetadataType,
                $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>,
            >,
    >(
        registry: R,
        ...meta: ZodString extends R["_schema"]
            ? undefined extends R["_meta"]
                ? [$replace<R["_meta"], R["_schema"] & ZodString>?]
                : [$replace<R["_meta"], R["_schema"] & ZodString>]
            : ["Incompatible schema"],
    ): this;
    brand<T extends PropertyKey = PropertyKey>(
        value?: T,
    ): PropertyKey extends T ? ZodString : $ZodBranded<ZodString, T>;
    parse(data: unknown, params?: ParseContext<$ZodIssue>): string;
    safeParse(
        data: unknown,
        params?: ParseContext<$ZodIssue>,
    ): ZodSafeParseResult<string>;
    parseAsync(
        data: unknown,
        params?: ParseContext<$ZodIssue>,
    ): Promise<string>;
    safeParseAsync(
        data: unknown,
        params?: ParseContext<$ZodIssue>,
    ): Promise<ZodSafeParseResult<string>>;
    spa: (
        data: unknown,
        params?: ParseContext<$ZodIssue>,
    ) => Promise<ZodSafeParseResult<string>>;
    encode(data: string, params?: ParseContext<$ZodIssue>): string;
    decode(data: string, params?: ParseContext<$ZodIssue>): string;
    encodeAsync(
        data: string,
        params?: ParseContext<$ZodIssue>,
    ): Promise<string>;
    decodeAsync(
        data: string,
        params?: ParseContext<$ZodIssue>,
    ): Promise<string>;
    safeEncode(
        data: string,
        params?: ParseContext<$ZodIssue>,
    ): ZodSafeParseResult<string>;
    safeDecode(
        data: string,
        params?: ParseContext<$ZodIssue>,
    ): ZodSafeParseResult<string>;
    safeEncodeAsync(
        data: string,
        params?: ParseContext<$ZodIssue>,
    ): Promise<ZodSafeParseResult<string>>;
    safeDecodeAsync(
        data: string,
        params?: ParseContext<$ZodIssue>,
    ): Promise<ZodSafeParseResult<string>>;
    refine(
        check: (arg: string) => unknown,
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<NonNullable<$ZodIssue>>;
                message?: string;
                abort?: boolean;
                when?: (payload: ParsePayload) => boolean;
                path?: PropertyKey[];
                params?: Record<string, any>;
            },
    ): this;
    superRefine(
        refinement: (
            arg: string,
            ctx: $RefinementCtx<string>,
        ) => void | Promise<void>,
    ): this;
    overwrite(fn: (x: string) => string): this;
    optional(): ZodOptional<ZodString>;
    nonoptional(
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueInvalidType<unknown>>;
                message?: string;
            },
    ): ZodNonOptional<ZodString>;
    nullable(): ZodNullable<ZodString>;
    nullish(): ZodOptional<ZodNullable<ZodString>>;
    default(def: string): ZodDefault<ZodString>;
    default(def: () => string): ZodDefault<ZodString>;
    prefault(def: () => string): ZodPrefault<ZodString>;
    prefault(def: string): ZodPrefault<ZodString>;
    array(): ZodArray<ZodString>;
    or<T extends SomeType>(option: T): ZodUnion<[ZodString, T]>;
    and<T extends SomeType>(incoming: T): ZodIntersection<ZodString, T>;
    transform<NewOut>(
        transform: (
            arg: string,
            ctx: $RefinementCtx<string>,
        ) => NewOut | Promise<NewOut>,
    ): ZodPipe<ZodString, ZodTransform<Awaited<NewOut>, string>>;
    catch(def: string): ZodCatch<ZodString>;
    catch(def: (ctx: $ZodCatchCtx) => string): ZodCatch<ZodString>;
    pipe<T extends $ZodType<any, string, $ZodTypeInternals<any, string>>>(
        target: T | $ZodType<any, string, $ZodTypeInternals<any, string>>,
    ): ZodPipe<ZodString, T>;
    readonly(): ZodReadonly<ZodString>;
    describe(description: string): this;
    description?: string;
    meta(): | undefined
    | {
        id?: string;
        title?: string;
        description?: string;
        deprecated?: boolean;
        [key: string]: unknown;
    };
    meta(
        data: {
            id?: string;
            title?: string;
            description?: string;
            deprecated?: boolean;
            [key: string]: unknown;
        },
    ): this;
    isOptional(): boolean;
    isNullable(): boolean;
    format: null | string;
    minLength: null | number;
    maxLength: null | number;
    regex(
        regex: RegExp,
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
                message?: string;
                abort?: boolean;
            },
    ): this;
    includes(
        value: string,
        params?: {
            error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
            message?: string;
            abort?: boolean;
            position?: number;
        },
    ): this;
    startsWith(
        value: string,
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
                message?: string;
                abort?: boolean;
            },
    ): this;
    endsWith(
        value: string,
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
                message?: string;
                abort?: boolean;
            },
    ): this;
    min(
        minLength: number,
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueTooSmall<HasLength>>;
                message?: string;
                abort?: boolean;
            },
    ): this;
    max(
        maxLength: number,
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueTooBig<HasLength>>;
                message?: string;
                abort?: boolean;
            },
    ): this;
    length(
        len: number,
        params?:
            | string
            | {
                error?: | string
                | $ZodErrorMap<
                    NonNullable<
                        $ZodIssueTooSmall<HasLength>
                        | $ZodIssueTooBig<HasLength>,
                    >,
                >;
                message?: string;
                abort?: boolean;
            },
    ): this;
    nonempty(
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueTooSmall<HasLength>>;
                message?: string;
                abort?: boolean;
            },
    ): this;
    lowercase(
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
                message?: string;
                abort?: boolean;
                pattern?: RegExp;
            },
    ): this;
    uppercase(
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
                message?: string;
                abort?: boolean;
                pattern?: RegExp;
            },
    ): this;
    trim(): this;
    normalize(form?: string & {} | "NFC" | "NFD" | "NFKC" | "NFKD"): this;
    toLowerCase(): this;
    toUpperCase(): this;
    email(
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
                message?: string;
                abort?: boolean;
                pattern?: RegExp;
            },
    ): this;
    url(
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
                message?: string;
                abort?: boolean;
                pattern?: RegExp;
                hostname?: RegExp;
                protocol?: RegExp;
                normalize?: boolean;
            },
    ): this;
    jwt(
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
                message?: string;
                abort?: boolean;
                alg?: JWTAlgorithm;
            },
    ): this;
    emoji(
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
                message?: string;
                abort?: boolean;
                pattern?: RegExp;
            },
    ): this;
    guid(
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
                message?: string;
                abort?: boolean;
            },
    ): this;
    guid(
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
                message?: string;
                abort?: boolean;
            },
    ): this;
    uuid(
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
                message?: string;
                abort?: boolean;
                version?: "v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "v7" | "v8";
            },
    ): this;
    uuidv4(
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
                message?: string;
                abort?: boolean;
                version?: "v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "v7" | "v8";
            },
    ): this;
    uuidv6(
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
                message?: string;
                abort?: boolean;
                version?: "v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "v7" | "v8";
            },
    ): this;
    uuidv7(
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
                message?: string;
                abort?: boolean;
                version?: "v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "v7" | "v8";
            },
    ): this;
    nanoid(
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
                message?: string;
                abort?: boolean;
                pattern?: RegExp;
            },
    ): this;
    cuid(
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
                message?: string;
                abort?: boolean;
                pattern?: RegExp;
            },
    ): this;
    cuid2(
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
                message?: string;
                abort?: boolean;
                pattern?: RegExp;
            },
    ): this;
    ulid(
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
                message?: string;
                abort?: boolean;
                pattern?: RegExp;
            },
    ): this;
    base64(
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
                message?: string;
                abort?: boolean;
            },
    ): this;
    base64url(
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
                message?: string;
                abort?: boolean;
            },
    ): this;
    xid(
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
                message?: string;
                abort?: boolean;
                pattern?: RegExp;
            },
    ): this;
    ksuid(
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
                message?: string;
                abort?: boolean;
                pattern?: RegExp;
            },
    ): this;
    ipv4(
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
                message?: string;
                abort?: boolean;
            },
    ): this;
    ipv6(
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
                message?: string;
                abort?: boolean;
            },
    ): this;
    cidrv4(
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
                message?: string;
                abort?: boolean;
                version?: "v4";
            },
    ): this;
    cidrv6(
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
                message?: string;
                abort?: boolean;
                version?: "v6";
            },
    ): this;
    e164(
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
                message?: string;
                abort?: boolean;
                pattern?: RegExp;
            },
    ): this;
    datetime(
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
                message?: string;
                abort?: boolean;
                precision?: null | number;
                offset?: boolean;
                local?: boolean;
            },
    ): this;
    date(
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
                message?: string;
                abort?: boolean;
            },
    ): this;
    time(
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
                message?: string;
                abort?: boolean;
                precision?: null | number;
            },
    ): this;
    duration(
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
                message?: string;
                abort?: boolean;
                pattern?: RegExp;
            },
    ): this;
    _zod: $ZodStringInternals;
    "~standard": $ZodStandardSchema<ZodString>;
}

Hierarchy (View Summary)

_ZodString<$ZodStringInternals<string>>
- ZodString

Properties

def

def: $ZodStringDef

type

type: "string"

_def

_def: $ZodStringDef

Deprecated

Use .def instead.

_output

_output: string

Deprecated

Use z.output<typeof schema> instead.

_input

_input: string

Deprecated

Use z.input<typeof schema> instead.

spa

spa: (
data: unknown,
params?: ParseContext<$ZodIssue>,
) => Promise<ZodSafeParseResult<string>>

`Optional`description

description?: string

format

format: null | string

minLength

minLength: null | number

maxLength

maxLength: null | number

_zod

_zod: $ZodStringInternals

~standard

"~standard": $ZodStandardSchema<ZodString>

Methods

check

check(...checks: ($ZodCheck<string> | CheckFn<string>)[]): this
Parameters
- ...checks: ($ZodCheck<string> | CheckFn<string>)[]
Returns this
Inherited from _ZodString.check
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:13

clone

clone(def?: $ZodStringDef, params?: { parent: boolean }): this
Parameters
- Optionaldef: $ZodStringDef
- Optionalparams: { parent: boolean }
Returns this
Inherited from _ZodString.clone
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:14

register

register<
    R extends
        $ZodRegistry<
            MetadataType,
            $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>,
        >,
>(
    registry: R,
    ...meta: ZodString extends R["_schema"]
        ? undefined extends R["_meta"]
            ? [$replace<R["_meta"], R["_schema"] & ZodString>?]
            : [$replace<R["_meta"], R["_schema"] & ZodString>]
        : ["Incompatible schema"],
): this
Type Parameters
- R extends $ZodRegistry<
  MetadataType,
  $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>,
  >
Parameters
- registry: R
- ...meta: ZodString extends R["_schema"]
      ? undefined extends R["_meta"]
          ? [$replace<R["_meta"], R["_schema"] & ZodString>?]
          : [$replace<R["_meta"], R["_schema"] & ZodString>]
      : ["Incompatible schema"]
Returns this
Inherited from _ZodString.register
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:17

brand

brand<T extends PropertyKey = PropertyKey>(
value?: T,
): PropertyKey extends T ? ZodString : $ZodBranded<ZodString, T>
Type Parameters
- T extends PropertyKey = PropertyKey
Parameters
- Optionalvalue: T
Returns PropertyKey extends T ? ZodString : $ZodBranded<ZodString, T>
Inherited from _ZodString.brand
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:18

parse

parse(data: unknown, params?: ParseContext<$ZodIssue>): string
Parameters
- data: unknown
- Optionalparams: ParseContext<$ZodIssue>
Returns string
Inherited from _ZodString.parse
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:19

safeParse

safeParse(
data: unknown,
params?: ParseContext<$ZodIssue>,
): ZodSafeParseResult<string>
Parameters
- data: unknown
- Optionalparams: ParseContext<$ZodIssue>
Returns ZodSafeParseResult<string>
Inherited from _ZodString.safeParse
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:20

parseAsync

parseAsync(data: unknown, params?: ParseContext<$ZodIssue>): Promise<string>
Parameters
- data: unknown
- Optionalparams: ParseContext<$ZodIssue>
Returns Promise<string>
Inherited from _ZodString.parseAsync
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:21

safeParseAsync

safeParseAsync(
data: unknown,
params?: ParseContext<$ZodIssue>,
): Promise<ZodSafeParseResult<string>>
Parameters
- data: unknown
- Optionalparams: ParseContext<$ZodIssue>
Returns Promise<ZodSafeParseResult<string>>
Inherited from _ZodString.safeParseAsync
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:22

encode

encode(data: string, params?: ParseContext<$ZodIssue>): string
Parameters
- data: string
- Optionalparams: ParseContext<$ZodIssue>
Returns string
Inherited from _ZodString.encode
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:24

decode

decode(data: string, params?: ParseContext<$ZodIssue>): string
Parameters
- data: string
- Optionalparams: ParseContext<$ZodIssue>
Returns string
Inherited from _ZodString.decode
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:25

encodeAsync

encodeAsync(data: string, params?: ParseContext<$ZodIssue>): Promise<string>
Parameters
- data: string
- Optionalparams: ParseContext<$ZodIssue>
Returns Promise<string>
Inherited from _ZodString.encodeAsync
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:26

decodeAsync

decodeAsync(data: string, params?: ParseContext<$ZodIssue>): Promise<string>
Parameters
- data: string
- Optionalparams: ParseContext<$ZodIssue>
Returns Promise<string>
Inherited from _ZodString.decodeAsync
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:27

safeEncode

safeEncode(
data: string,
params?: ParseContext<$ZodIssue>,
): ZodSafeParseResult<string>
Parameters
- data: string
- Optionalparams: ParseContext<$ZodIssue>
Returns ZodSafeParseResult<string>
Inherited from _ZodString.safeEncode
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:28

safeDecode

safeDecode(
data: string,
params?: ParseContext<$ZodIssue>,
): ZodSafeParseResult<string>
Parameters
- data: string
- Optionalparams: ParseContext<$ZodIssue>
Returns ZodSafeParseResult<string>
Inherited from _ZodString.safeDecode
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:29

safeEncodeAsync

safeEncodeAsync(
data: string,
params?: ParseContext<$ZodIssue>,
): Promise<ZodSafeParseResult<string>>
Parameters
- data: string
- Optionalparams: ParseContext<$ZodIssue>
Returns Promise<ZodSafeParseResult<string>>
Inherited from _ZodString.safeEncodeAsync
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:30

safeDecodeAsync

safeDecodeAsync(
data: string,
params?: ParseContext<$ZodIssue>,
): Promise<ZodSafeParseResult<string>>
Parameters
- data: string
- Optionalparams: ParseContext<$ZodIssue>
Returns Promise<ZodSafeParseResult<string>>
Inherited from _ZodString.safeDecodeAsync
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:31

refine

refine(
    check: (arg: string) => unknown,
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<NonNullable<$ZodIssue>>;
            message?: string;
            abort?: boolean;
            when?: (payload: ParsePayload) => boolean;
            path?: PropertyKey[];
            params?: Record<string, any>;
        },
): this
Parameters
- check: (arg: string) => unknown
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<NonNullable<$ZodIssue>>;
          message?: string;
          abort?: boolean;
          when?: (payload: ParsePayload) => boolean;
          path?: PropertyKey[];
          params?: Record<string, any>;
      }
  - string
  - {
        error?: string | $ZodErrorMap<NonNullable<$ZodIssue>>;
        message?: string;
        abort?: boolean;
        when?: (payload: ParsePayload) => boolean;
        path?: PropertyKey[];
        params?: Record<string, any>;
    }
    Optionalerror?: string | $ZodErrorMap<NonNullable<$ZodIssue>>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
    
    Optionalwhen?: (payload: ParsePayload) => boolean
    If provided, this check will only be executed if the function returns true. Defaults to payload => z.util.isAborted(payload).
    
    Optionalpath?: PropertyKey[]
    Optionalparams?: Record<string, any>
Returns this
Inherited from _ZodString.refine
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:32

superRefine

superRefine(
    refinement: (
        arg: string,
        ctx: $RefinementCtx<string>,
    ) => void | Promise<void>,
): this
Parameters
- refinement: (arg: string, ctx: $RefinementCtx<string>) => void | Promise<void>
Returns this
Inherited from _ZodString.superRefine
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:33

overwrite

overwrite(fn: (x: string) => string): this
Parameters
- fn: (x: string) => string
Returns this
Inherited from _ZodString.overwrite
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:34

optional

optional(): ZodOptional<ZodString>
Returns ZodOptional<ZodString>
Inherited from _ZodString.optional
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:35

nonoptional

nonoptional(
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueInvalidType<unknown>>;
            message?: string;
        },
): ZodNonOptional<ZodString>
Parameters
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueInvalidType<unknown>>;
          message?: string;
      }
  - string
  - {
    error?: string | $ZodErrorMap<$ZodIssueInvalidType<unknown>>;
    message?: string;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueInvalidType<unknown>>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
Returns ZodNonOptional<ZodString>
Inherited from _ZodString.nonoptional
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:36

nullable

nullable(): ZodNullable<ZodString>
Returns ZodNullable<ZodString>
Inherited from _ZodString.nullable
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:37

nullish

nullish(): ZodOptional<ZodNullable<ZodString>>
Returns ZodOptional<ZodNullable<ZodString>>
Inherited from _ZodString.nullish
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:38

default

default(def: string): ZodDefault<ZodString>
Parameters
- def: string
Returns ZodDefault<ZodString>
Inherited from _ZodString.default
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:39
default(def: () => string): ZodDefault<ZodString>
Parameters
- def: () => string
Returns ZodDefault<ZodString>
Inherited from _ZodString.default
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:40

prefault

prefault(def: () => string): ZodPrefault<ZodString>
Parameters
- def: () => string
Returns ZodPrefault<ZodString>
Inherited from _ZodString.prefault
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:41
prefault(def: string): ZodPrefault<ZodString>
Parameters
- def: string
Returns ZodPrefault<ZodString>
Inherited from _ZodString.prefault
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:42

array

array(): ZodArray<ZodString>
Returns ZodArray<ZodString>
Inherited from _ZodString.array
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:43

or

or<T extends SomeType>(option: T): ZodUnion<[ZodString, T]>
Type Parameters
- T extends SomeType
Parameters
- option: T
Returns ZodUnion<[ZodString, T]>
Inherited from _ZodString.or
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:44

and

and<T extends SomeType>(incoming: T): ZodIntersection<ZodString, T>
Type Parameters
- T extends SomeType
Parameters
- incoming: T
Returns ZodIntersection<ZodString, T>
Inherited from _ZodString.and
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:45

transform

transform<NewOut>(
    transform: (
        arg: string,
        ctx: $RefinementCtx<string>,
    ) => NewOut | Promise<NewOut>,
): ZodPipe<ZodString, ZodTransform<Awaited<NewOut>, string>>
Type Parameters
- NewOut
Parameters
- transform: (arg: string, ctx: $RefinementCtx<string>) => NewOut | Promise<NewOut>
Returns ZodPipe<ZodString, ZodTransform<Awaited<NewOut>, string>>
Inherited from _ZodString.transform
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:46

catch

catch(def: string): ZodCatch<ZodString>
Parameters
- def: string
Returns ZodCatch<ZodString>
Inherited from _ZodString.catch
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:47
catch(def: (ctx: $ZodCatchCtx) => string): ZodCatch<ZodString>
Parameters
- def: (ctx: $ZodCatchCtx) => string
Returns ZodCatch<ZodString>
Inherited from _ZodString.catch
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:48

pipe

pipe<T extends $ZodType<any, string, $ZodTypeInternals<any, string>>>(
target: T | $ZodType<any, string, $ZodTypeInternals<any, string>>,
): ZodPipe<ZodString, T>
Type Parameters
- T extends $ZodType<any, string, $ZodTypeInternals<any, string>>
Parameters
- target: T | $ZodType<any, string, $ZodTypeInternals<any, string>>
Returns ZodPipe<ZodString, T>
Inherited from _ZodString.pipe
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:49

readonly

readonly(): ZodReadonly<ZodString>
Returns ZodReadonly<ZodString>
Inherited from _ZodString.readonly
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:50

describe

describe(description: string): this
Returns a new instance that has been registered in z.globalRegistry with the specified description
Parameters
- description: string
Returns this
Inherited from _ZodString.describe
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:52

isOptional

isOptional(): boolean
Returns boolean
Deprecated
Try safe-parsing undefined (this is what isOptional does internally):
```
const schema = z.string().optional();
const isOptional = schema.safeParse(undefined).success; // true
```
Inherited from _ZodString.isOptional
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:65

isNullable

isNullable(): boolean
Returns boolean
Deprecated
Try safe-parsing null (this is what isNullable does internally):
```
const schema = z.string().nullable();
const isNullable = schema.safeParse(null).success; // true
```
Inherited from _ZodString.isNullable
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:74

regex

regex(
    regex: RegExp,
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
            message?: string;
            abort?: boolean;
        },
): this
Parameters
- regex: RegExp
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
          message?: string;
          abort?: boolean;
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
        message?: string;
        abort?: boolean;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
Returns this
Inherited from _ZodString.regex
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:83

includes

includes(
    value: string,
    params?: {
        error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
        message?: string;
        abort?: boolean;
        position?: number;
    },
): this
Parameters
- value: string
- Optionalparams: {
      error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
      message?: string;
      abort?: boolean;
      position?: number;
  }
  - Optionalerror?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
  - Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
  - Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
  - Optionalposition?: number
Returns this
Inherited from _ZodString.includes
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:84

startsWith

startsWith(
    value: string,
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
            message?: string;
            abort?: boolean;
        },
): this
Parameters
- value: string
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
          message?: string;
          abort?: boolean;
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
        message?: string;
        abort?: boolean;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
Returns this
Inherited from _ZodString.startsWith
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:85

endsWith

endsWith(
    value: string,
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
            message?: string;
            abort?: boolean;
        },
): this
Parameters
- value: string
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
          message?: string;
          abort?: boolean;
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
        message?: string;
        abort?: boolean;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
Returns this
Inherited from _ZodString.endsWith
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:86

min

min(
    minLength: number,
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueTooSmall<HasLength>>;
            message?: string;
            abort?: boolean;
        },
): this
Parameters
- minLength: number
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueTooSmall<HasLength>>;
          message?: string;
          abort?: boolean;
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueTooSmall<HasLength>>;
        message?: string;
        abort?: boolean;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueTooSmall<HasLength>>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
Returns this
Inherited from _ZodString.min
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:87

max

max(
    maxLength: number,
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueTooBig<HasLength>>;
            message?: string;
            abort?: boolean;
        },
): this
Parameters
- maxLength: number
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueTooBig<HasLength>>;
          message?: string;
          abort?: boolean;
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueTooBig<HasLength>>;
        message?: string;
        abort?: boolean;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueTooBig<HasLength>>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
Returns this
Inherited from _ZodString.max
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:88

length

length(
    len: number,
    params?:
        | string
        | {
            error?: | string
            | $ZodErrorMap<
                NonNullable<
                    $ZodIssueTooSmall<HasLength>
                    | $ZodIssueTooBig<HasLength>,
                >,
            >;
            message?: string;
            abort?: boolean;
        },
): this
Parameters
- len: number
- Optionalparams:
      | string
      | {
          error?: | string
          | $ZodErrorMap<
              NonNullable<$ZodIssueTooSmall<HasLength> | $ZodIssueTooBig<HasLength>>,
          >;
          message?: string;
          abort?: boolean;
      }
  - string
  - {
        error?:
            | string
            | $ZodErrorMap<
                NonNullable<$ZodIssueTooSmall<HasLength> | $ZodIssueTooBig<HasLength>>,
            >;
        message?: string;
        abort?: boolean;
    }
    Optionalerror?:
        | string
        | $ZodErrorMap<
            NonNullable<$ZodIssueTooSmall<HasLength> | $ZodIssueTooBig<HasLength>>,
        >
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
Returns this
Inherited from _ZodString.length
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:89

nonempty

nonempty(
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueTooSmall<HasLength>>;
            message?: string;
            abort?: boolean;
        },
): this
Parameters
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueTooSmall<HasLength>>;
          message?: string;
          abort?: boolean;
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueTooSmall<HasLength>>;
        message?: string;
        abort?: boolean;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueTooSmall<HasLength>>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
Returns this
Inherited from _ZodString.nonempty
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:90

lowercase

lowercase(
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
            message?: string;
            abort?: boolean;
            pattern?: RegExp;
        },
): this
Parameters
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
          message?: string;
          abort?: boolean;
          pattern?: RegExp;
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
        message?: string;
        abort?: boolean;
        pattern?: RegExp;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
    
    Optionalpattern?: RegExp
Returns this
Inherited from _ZodString.lowercase
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:91

uppercase

uppercase(
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
            message?: string;
            abort?: boolean;
            pattern?: RegExp;
        },
): this
Parameters
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
          message?: string;
          abort?: boolean;
          pattern?: RegExp;
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
        message?: string;
        abort?: boolean;
        pattern?: RegExp;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
    
    Optionalpattern?: RegExp
Returns this
Inherited from _ZodString.uppercase
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:92

trim

trim(): this
Returns this
Inherited from _ZodString.trim
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:93

normalize

normalize(form?: string & {} | "NFC" | "NFD" | "NFKC" | "NFKD"): this
Parameters
- Optionalform: string & {} | "NFC" | "NFD" | "NFKC" | "NFKD"
Returns this
Inherited from _ZodString.normalize
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:94

toLowerCase

toLowerCase(): this
Returns this
Inherited from _ZodString.toLowerCase
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:95

toUpperCase

toUpperCase(): this
Returns this
Inherited from _ZodString.toUpperCase
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:96

email

email(
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
            message?: string;
            abort?: boolean;
            pattern?: RegExp;
        },
): this
Parameters
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
          message?: string;
          abort?: boolean;
          pattern?: RegExp;
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
        message?: string;
        abort?: boolean;
        pattern?: RegExp;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
    
    Optionalpattern?: RegExp
Returns this
Deprecated
Use z.email() instead.
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:102

url

url(
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
            message?: string;
            abort?: boolean;
            pattern?: RegExp;
            hostname?: RegExp;
            protocol?: RegExp;
            normalize?: boolean;
        },
): this
Parameters
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
          message?: string;
          abort?: boolean;
          pattern?: RegExp;
          hostname?: RegExp;
          protocol?: RegExp;
          normalize?: boolean;
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
        message?: string;
        abort?: boolean;
        pattern?: RegExp;
        hostname?: RegExp;
        protocol?: RegExp;
        normalize?: boolean;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
    
    Optionalpattern?: RegExp
    Optionalhostname?: RegExp
    Optionalprotocol?: RegExp
    Optionalnormalize?: boolean
Returns this
Deprecated
Use z.url() instead.
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:104

jwt

jwt(
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
            message?: string;
            abort?: boolean;
            alg?: JWTAlgorithm;
        },
): this
Parameters
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
          message?: string;
          abort?: boolean;
          alg?: JWTAlgorithm;
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
        message?: string;
        abort?: boolean;
        alg?: JWTAlgorithm;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
    
    Optionalalg?: JWTAlgorithm
Returns this
Deprecated
Use z.jwt() instead.
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:106

emoji

emoji(
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
            message?: string;
            abort?: boolean;
            pattern?: RegExp;
        },
): this
Parameters
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
          message?: string;
          abort?: boolean;
          pattern?: RegExp;
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
        message?: string;
        abort?: boolean;
        pattern?: RegExp;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
    
    Optionalpattern?: RegExp
Returns this
Deprecated
Use z.emoji() instead.
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:108

guid

guid(
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
            message?: string;
            abort?: boolean;
        },
): this
Parameters
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
          message?: string;
          abort?: boolean;
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
        message?: string;
        abort?: boolean;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
Returns this
Deprecated
Use z.guid() instead.
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:110
guid(
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
            message?: string;
            abort?: boolean;
        },
): this
Parameters
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
          message?: string;
          abort?: boolean;
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
        message?: string;
        abort?: boolean;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
Returns this
Deprecated
Use z.guid() instead.
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:122

uuid

uuid(
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
            message?: string;
            abort?: boolean;
            version?: "v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "v7" | "v8";
        },
): this
Parameters
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
          message?: string;
          abort?: boolean;
          version?: "v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "v7" | "v8";
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
        message?: string;
        abort?: boolean;
        version?: "v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "v7" | "v8";
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
    
    Optionalversion?: "v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "v7" | "v8"
Returns this
Deprecated
Use z.uuid() instead.
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:112

uuidv4

uuidv4(
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
            message?: string;
            abort?: boolean;
            version?: "v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "v7" | "v8";
        },
): this
Parameters
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
          message?: string;
          abort?: boolean;
          version?: "v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "v7" | "v8";
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
        message?: string;
        abort?: boolean;
        version?: "v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "v7" | "v8";
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
    
    Optionalversion?: "v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "v7" | "v8"
Returns this
Deprecated
Use z.uuid() instead.
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:114

uuidv6

uuidv6(
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
            message?: string;
            abort?: boolean;
            version?: "v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "v7" | "v8";
        },
): this
Parameters
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
          message?: string;
          abort?: boolean;
          version?: "v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "v7" | "v8";
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
        message?: string;
        abort?: boolean;
        version?: "v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "v7" | "v8";
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
    
    Optionalversion?: "v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "v7" | "v8"
Returns this
Deprecated
Use z.uuid() instead.
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:116

uuidv7

uuidv7(
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
            message?: string;
            abort?: boolean;
            version?: "v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "v7" | "v8";
        },
): this
Parameters
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
          message?: string;
          abort?: boolean;
          version?: "v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "v7" | "v8";
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
        message?: string;
        abort?: boolean;
        version?: "v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "v7" | "v8";
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
    
    Optionalversion?: "v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "v7" | "v8"
Returns this
Deprecated
Use z.uuid() instead.
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:118

nanoid

nanoid(
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
            message?: string;
            abort?: boolean;
            pattern?: RegExp;
        },
): this
Parameters
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
          message?: string;
          abort?: boolean;
          pattern?: RegExp;
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
        message?: string;
        abort?: boolean;
        pattern?: RegExp;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
    
    Optionalpattern?: RegExp
Returns this
Deprecated
Use z.nanoid() instead.
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:120

cuid

cuid(
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
            message?: string;
            abort?: boolean;
            pattern?: RegExp;
        },
): this
Parameters
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
          message?: string;
          abort?: boolean;
          pattern?: RegExp;
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
        message?: string;
        abort?: boolean;
        pattern?: RegExp;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
    
    Optionalpattern?: RegExp
Returns this
Deprecated
Use z.cuid() instead.
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:124

cuid2

cuid2(
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
            message?: string;
            abort?: boolean;
            pattern?: RegExp;
        },
): this
Parameters
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
          message?: string;
          abort?: boolean;
          pattern?: RegExp;
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
        message?: string;
        abort?: boolean;
        pattern?: RegExp;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
    
    Optionalpattern?: RegExp
Returns this
Deprecated
Use z.cuid2() instead.
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:126

ulid

ulid(
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
            message?: string;
            abort?: boolean;
            pattern?: RegExp;
        },
): this
Parameters
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
          message?: string;
          abort?: boolean;
          pattern?: RegExp;
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
        message?: string;
        abort?: boolean;
        pattern?: RegExp;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
    
    Optionalpattern?: RegExp
Returns this
Deprecated
Use z.ulid() instead.
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:128

base64

base64(
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
            message?: string;
            abort?: boolean;
        },
): this
Parameters
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
          message?: string;
          abort?: boolean;
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
        message?: string;
        abort?: boolean;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
Returns this
Deprecated
Use z.base64() instead.
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:130

base64url

base64url(
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
            message?: string;
            abort?: boolean;
        },
): this
Parameters
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
          message?: string;
          abort?: boolean;
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
        message?: string;
        abort?: boolean;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
Returns this
Deprecated
Use z.base64url() instead.
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:132

xid

xid(
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
            message?: string;
            abort?: boolean;
            pattern?: RegExp;
        },
): this
Parameters
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
          message?: string;
          abort?: boolean;
          pattern?: RegExp;
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
        message?: string;
        abort?: boolean;
        pattern?: RegExp;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
    
    Optionalpattern?: RegExp
Returns this
Deprecated
Use z.xid() instead.
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:134

ksuid

ksuid(
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
            message?: string;
            abort?: boolean;
            pattern?: RegExp;
        },
): this
Parameters
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
          message?: string;
          abort?: boolean;
          pattern?: RegExp;
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
        message?: string;
        abort?: boolean;
        pattern?: RegExp;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
    
    Optionalpattern?: RegExp
Returns this
Deprecated
Use z.ksuid() instead.
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:136

ipv4

ipv4(
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
            message?: string;
            abort?: boolean;
        },
): this
Parameters
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
          message?: string;
          abort?: boolean;
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
        message?: string;
        abort?: boolean;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
Returns this
Deprecated
Use z.ipv4() instead.
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:138

ipv6

ipv6(
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
            message?: string;
            abort?: boolean;
        },
): this
Parameters
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
          message?: string;
          abort?: boolean;
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
        message?: string;
        abort?: boolean;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
Returns this
Deprecated
Use z.ipv6() instead.
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:140

cidrv4

cidrv4(
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
            message?: string;
            abort?: boolean;
            version?: "v4";
        },
): this
Parameters
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
          message?: string;
          abort?: boolean;
          version?: "v4";
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
        message?: string;
        abort?: boolean;
        version?: "v4";
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
    
    Optionalversion?: "v4"
Returns this
Deprecated
Use z.cidrv4() instead.
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:142

cidrv6

cidrv6(
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
            message?: string;
            abort?: boolean;
            version?: "v6";
        },
): this
Parameters
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
          message?: string;
          abort?: boolean;
          version?: "v6";
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
        message?: string;
        abort?: boolean;
        version?: "v6";
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
    
    Optionalversion?: "v6"
Returns this
Deprecated
Use z.cidrv6() instead.
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:144

e164

e164(
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
            message?: string;
            abort?: boolean;
            pattern?: RegExp;
        },
): this
Parameters
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
          message?: string;
          abort?: boolean;
          pattern?: RegExp;
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
        message?: string;
        abort?: boolean;
        pattern?: RegExp;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
    
    Optionalpattern?: RegExp
Returns this
Deprecated
Use z.e164() instead.
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:146

datetime

datetime(
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
            message?: string;
            abort?: boolean;
            precision?: null | number;
            offset?: boolean;
            local?: boolean;
        },
): this
Parameters
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
          message?: string;
          abort?: boolean;
          precision?: null | number;
          offset?: boolean;
          local?: boolean;
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
        message?: string;
        abort?: boolean;
        precision?: null | number;
        offset?: boolean;
        local?: boolean;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
    
    Optionalprecision?: null | number
    Optionaloffset?: boolean
    Optionallocal?: boolean
Returns this
Deprecated
Use z.iso.datetime() instead.
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:148

date

date(
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
            message?: string;
            abort?: boolean;
        },
): this
Parameters
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
          message?: string;
          abort?: boolean;
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
        message?: string;
        abort?: boolean;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
Returns this
Deprecated
Use z.iso.date() instead.
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:150

time

time(
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
            message?: string;
            abort?: boolean;
            precision?: null | number;
        },
): this
Parameters
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
          message?: string;
          abort?: boolean;
          precision?: null | number;
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
        message?: string;
        abort?: boolean;
        precision?: null | number;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
    
    Optionalprecision?: null | number
Returns this
Deprecated
Use z.iso.time() instead.
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:152

duration

duration(
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
            message?: string;
            abort?: boolean;
            pattern?: RegExp;
        },
): this
Parameters
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
          message?: string;
          abort?: boolean;
          pattern?: RegExp;
      }
  - string
  - {
        error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
        message?: string;
        abort?: boolean;
        pattern?: RegExp;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
    
    Optionalpattern?: RegExp
Returns this
Deprecated
Use z.iso.duration() instead.
- Defined in ../../node_modules/zod/v4/classic/schemas.d.cts:154

Interface ZodString

Hierarchy (View Summary)

Index

Properties

Methods

Properties

def

type

_def

Deprecated

_output

Deprecated

_input

Deprecated

spa

Optionaldescription

format

minLength

maxLength

_zod

~standard

Methods

check

Parameters

Returns this

clone

Parameters

Returns this

register

Type Parameters

Parameters

Returns this

brand

Type Parameters

Parameters

Returns PropertyKey extends T ? ZodString : $ZodBranded<ZodString, T>

parse

Parameters

Returns string

safeParse

Parameters

Returns ZodSafeParseResult<string>

parseAsync

Parameters

Returns Promise<string>

safeParseAsync

Parameters

Returns Promise<ZodSafeParseResult<string>>

encode

Parameters

Returns string

decode

Parameters

Returns string

encodeAsync

Parameters

Returns Promise<string>

decodeAsync

Parameters

Returns Promise<string>

safeEncode

Parameters

Returns ZodSafeParseResult<string>

safeDecode

Parameters

Returns ZodSafeParseResult<string>

safeEncodeAsync

Parameters

Returns Promise<ZodSafeParseResult<string>>

safeDecodeAsync

Parameters

Returns Promise<ZodSafeParseResult<string>>

refine

Parameters

Optionalerror?: string | $ZodErrorMap<NonNullable<$ZodIssue>>

Optionalmessage?: string

Deprecated

Optionalabort?: boolean

Optionalwhen?: (payload: ParsePayload) => boolean

Optionalpath?: PropertyKey[]

`Optional`description

`Optional`error?: string | $ZodErrorMap<NonNullable<$ZodIssue>>

`Optional`message?: string

`Optional`abort?: boolean

`Optional`when?: (payload: ParsePayload) => boolean

`Optional`path?: PropertyKey[]

`Optional`params?: Record<string, any>

`Optional`error?: string | $ZodErrorMap<$ZodIssueInvalidType<unknown>>

`Optional`message?: string

Returns
| undefined
| {
id?: string;
title?: string;
description?: string;
deprecated?: boolean;
[key: string]: unknown;
}