Membrane React - v0.6.0
    Preparing search index...

    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)

    Index

    Methods

    check clone register brand parse safeParse parseAsync safeParseAsync encode decode encodeAsync decodeAsync safeEncode safeDecode safeEncodeAsync safeDecodeAsync refine superRefine overwrite optional nonoptional nullable nullish default prefault array or and transform catch pipe readonly describe meta isOptional isNullable regex includes startsWith endsWith min max length nonempty lowercase uppercase trim normalize toLowerCase toUpperCase email url jwt emoji guid uuid uuidv4 uuidv6 uuidv7 nanoid cuid cuid2 ulid base64 base64url xid ksuid ipv4 ipv6 cidrv4 cidrv6 e164 datetime date time duration

    Properties

    def type _def _output _input spa description? format minLength maxLength _zod ~standard

    Methods

    • Parameters

      Returns 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

            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

    • Parameters

      • refinement: (arg: string, ctx: $RefinementCtx<string>) => void | Promise<void>

      Returns this

    • Parameters

      • fn: (x: string) => string

      Returns this

    • Returns a new instance that has been registered in z.globalRegistry with the specified description

      Parameters

      • description: string

      Returns this

    • Returns the metadata associated with this instance in z.globalRegistry

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

    • Returns a new instance that has been registered in z.globalRegistry with the specified metadata

      Parameters

      • data: {
            id?: string;
            title?: string;
            description?: string;
            deprecated?: boolean;
            [key: string]: unknown;
        }

      Returns this

    • Returns boolean

      Try safe-parsing undefined (this is what isOptional does internally):

      const schema = z.string().optional();
      const isOptional = schema.safeParse(undefined).success; // true

    • Returns boolean

      Try safe-parsing null (this is what isNullable does internally):

      const schema = z.string().nullable();
      const isNullable = schema.safeParse(null).success; // true

    • Parameters

      Returns this

    • Parameters

      • value: string
      • Optionalparams: {
            error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>;
            message?: string;
            abort?: boolean;
            position?: number;
        }
        • Optionalerror?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
        • Optionalmessage?: string

          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

    • Parameters

      Returns this

    • Parameters

      Returns this

    • Parameters

      • minLength: number
      • Optionalparams:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueTooSmall<HasLength>>;
                message?: string;
                abort?: boolean;
            }

      Returns 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

            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

    • Parameters

      Returns this

    • Parameters

      • Optionalparams:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueTooSmall<HasLength>>;
                message?: string;
                abort?: boolean;
            }

      Returns 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

            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

    • 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

            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

    • Returns this

    • Parameters

      • Optionalform: string & {} | "NFC" | "NFD" | "NFKC" | "NFKD"

      Returns this

    • Returns this

    • Returns 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

            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

      Use z.email() instead.

    • 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

            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

      Use z.url() instead.

    • Parameters

      Returns this

      Use z.jwt() instead.

    • 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

            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

      Use z.emoji() instead.

    • Parameters

      Returns this

      Use z.guid() instead.

    • Parameters

      Returns this

      Use z.guid() instead.

    • 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

            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

      Use z.uuid() instead.

    • 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

            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

      Use z.uuid() instead.

    • 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

            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

      Use z.uuid() instead.

    • 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

            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

      Use z.uuid() instead.

    • 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

            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

      Use z.nanoid() instead.

    • 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

            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

      Use z.cuid() instead.

    • 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

            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

      Use z.cuid2() instead.

    • 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

            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

      Use z.ulid() instead.

    • Parameters

      Returns this

      Use z.base64() instead.

    • Parameters

      Returns this

      Use z.base64url() instead.

    • 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

            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

      Use z.xid() instead.

    • 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

            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

      Use z.ksuid() instead.

    • Parameters

      Returns this

      Use z.ipv4() instead.

    • Parameters

      Returns this

      Use z.ipv6() instead.

    • 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

            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

      Use z.cidrv4() instead.

    • 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

            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

      Use z.cidrv6() instead.

    • 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

            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

      Use z.e164() instead.

    • 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

            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

      Use z.iso.datetime() instead.

    • Parameters

      Returns this

      Use z.iso.date() instead.

    • 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

            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

      Use z.iso.time() instead.

    • 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

            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

      Use z.iso.duration() instead.

    Properties

    def: $ZodStringDef
    type: "string"

    _def

    _def: $ZodStringDef

    Use .def instead.

    _output

    _output: string

    Use z.output<typeof schema> instead.

    _input

    _input: string

    Use z.input<typeof schema> instead.

    spa: (
        data: unknown,
        params?: ParseContext<$ZodIssue>,
    ) => Promise<ZodSafeParseResult<string>>
    description?: string
    format: null | string
    minLength: null | number
    maxLength: null | number

    _zod

    _zod: $ZodStringInternals
    "~standard": $ZodStandardSchema<ZodString>

    Settings

    Member Visibility

    On This Page

    Methods
    Properties