Type Alias ZodStringV3

ZodStringV3: {
    and: (<T>(incoming: T) => ZodIntersection<ZodString, T>);
    array: (() => ZodArray<ZodString, "many">);
    base64: ((message?: ErrMessage) => ZodString);
    base64url: ((message?: ErrMessage) => ZodString);
    brand: (<B>(brand?: B) => ZodBranded<ZodString, B>);
    catch: {
        (def: string): ZodCatch<ZodString>;
        (def: ((ctx: {
            error: ZodError<any>;
            input: string;
        }) => string)): ZodCatch<ZodString>;
    };
    cidr: ((options?: string | {
        message?: string;
        version?: IpVersion;
    }) => ZodString);
    cuid: ((message?: ErrMessage) => ZodString);
    cuid2: ((message?: ErrMessage) => ZodString);
    date: ((message?: string) => ZodString);
    datetime: ((options?: string | {
        local?: boolean;
        message?: string;
        offset?: boolean;
        precision?: null | number;
    }) => ZodString);
    default: {
        (def: string): ZodDefault<ZodString>;
        (def: (() => string)): ZodDefault<ZodString>;
    };
    describe: ((description: string) => this);
    description: undefined | string;
    duration: ((message?: ErrMessage) => ZodString);
    email: ((message?: ErrMessage) => ZodString);
    emoji: ((message?: ErrMessage) => ZodString);
    endsWith: ((value: string, message?: ErrMessage) => ZodString);
    includes: ((value: string, options?: {
        message?: string;
        position?: number;
    }) => ZodString);
    ip: ((options?: string | {
        message?: string;
        version?: IpVersion;
    }) => ZodString);
    isBase64: boolean;
    isBase64url: boolean;
    isCIDR: boolean;
    isCUID: boolean;
    isCUID2: boolean;
    isDate: boolean;
    isDatetime: boolean;
    isDuration: boolean;
    isEmail: boolean;
    isEmoji: boolean;
    isIP: boolean;
    isNANOID: boolean;
    isNullable: (() => boolean);
    isOptional: (() => boolean);
    isTime: boolean;
    isULID: boolean;
    isURL: boolean;
    isUUID: boolean;
    jwt: ((options?: {
        alg?: string;
        message?: string;
    }) => ZodString);
    length: ((len: number, message?: ErrMessage) => ZodString);
    max: ((maxLength: number, message?: ErrMessage) => ZodString);
    maxLength: null | number;
    min: ((minLength: number, message?: ErrMessage) => ZodString);
    minLength: null | number;
    nanoid: ((message?: ErrMessage) => ZodString);
    nonempty: ((message?: ErrMessage) => ZodString);
    nullable: (() => ZodNullable<ZodString>);
    nullish: (() => ZodOptional<ZodNullable<ZodString>>);
    optional: (() => ZodOptional<ZodString>);
    or: (<T>(option: T) => ZodUnion<[ZodString, T]>);
    parse: ((data: unknown, params?: InexactPartial<ParseParams>) => string);
    parseAsync: ((data: unknown, params?: InexactPartial<ParseParams>) => Promise<string>);
    pipe: (<T>(target: T) => ZodPipeline<ZodString, T>);
    promise: (() => ZodPromise<ZodString>);
    readonly: (() => ZodReadonly<ZodString>);
    refine: {
        <RefinedOutput>(check: ((arg: string) => arg is RefinedOutput), message?: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg: string) => Partial<Omit<ZodCustomIssue, "code">>)): ZodEffects<ZodString, RefinedOutput, string>;
        (check: ((arg: string) => unknown), message?: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg: string) => Partial<Omit<ZodCustomIssue, "code">>)): ZodEffects<ZodString, string, string>;
    };
    refinement: {
        <RefinedOutput>(check: ((arg: string) => arg is RefinedOutput), refinementData: IssueData | ((arg: string, ctx: RefinementCtx) => IssueData)): ZodEffects<ZodString, RefinedOutput, string>;
        (check: ((arg: string) => boolean), refinementData: IssueData | ((arg: string, ctx: RefinementCtx) => IssueData)): ZodEffects<ZodString, string, string>;
    };
    regex: ((regex: RegExp, message?: ErrMessage) => ZodString);
    safeParse: ((data: unknown, params?: InexactPartial<ParseParams>) => SafeParseReturnType<string, string>);
    safeParseAsync: ((data: unknown, params?: InexactPartial<ParseParams>) => Promise<SafeParseReturnType<string, string>>);
    spa: ((data: unknown, params?: InexactPartial<ParseParams>) => Promise<SafeParseReturnType<string, string>>);
    startsWith: ((value: string, message?: ErrMessage) => ZodString);
    superRefine: {
        <RefinedOutput>(refinement: ((arg: string, ctx: RefinementCtx) => arg is RefinedOutput)): ZodEffects<ZodString, RefinedOutput, string>;
        (refinement: ((arg: string, ctx: RefinementCtx) => void)): ZodEffects<ZodString, string, string>;
        (refinement: ((arg: string, ctx: RefinementCtx) => Promise<void>)): ZodEffects<ZodString, string, string>;
    };
    time: ((options?: string | {
        message?: string;
        precision?: null | number;
    }) => ZodString);
    toLowerCase: (() => ZodString);
    toUpperCase: (() => ZodString);
    transform: (<NewOut>(transform: ((arg: string, ctx: RefinementCtx) => NewOut | Promise<NewOut>)) => ZodEffects<ZodString, NewOut, string>);
    trim: (() => ZodString);
    ulid: ((message?: ErrMessage) => ZodString);
    url: ((message?: ErrMessage) => ZodString);
    uuid: ((message?: ErrMessage) => ZodString);
    ~standard: Props<string, string>;
    ~validate: ((data: unknown) => Result<string> | Promise<Result<string>>);
}

Type declaration

  • and: (<T>(incoming: T) => ZodIntersection<ZodString, T>)
      • <T>(incoming): ZodIntersection<ZodString, T>

      • Type Parameters

        • T extends ZodTypeAny

        Parameters

        • incoming: T

        Returns ZodIntersection<ZodString, T>

  • array: (() => ZodArray<ZodString, "many">)
      • (): ZodArray<ZodString, "many">

      • Returns ZodArray<ZodString, "many">

  • base64: ((message?: ErrMessage) => ZodString)
      • (message?): ZodString

      • Parameters

        • Optionalmessage: ErrMessage

        Returns ZodString

  • base64url: ((message?: ErrMessage) => ZodString)
      • (message?): ZodString

      • Parameters

        • Optionalmessage: ErrMessage

        Returns ZodString

  • brand: (<B>(brand?: B) => ZodBranded<ZodString, B>)
      • <B>(brand?): ZodBranded<ZodString, B>

      • Type Parameters

        • B extends string | number | symbol

        Parameters

        • Optionalbrand: B

        Returns ZodBranded<ZodString, B>

  • catch: {
        (def: string): ZodCatch<ZodString>;
        (def: ((ctx: {
            error: ZodError<any>;
            input: string;
        }) => string)): ZodCatch<ZodString>;
    }
      • (def): ZodCatch<ZodString>

      • Parameters

        • def: string

        Returns ZodCatch<ZodString>

      • (def): ZodCatch<ZodString>

      • Parameters

        • def: ((ctx: {
              error: ZodError<any>;
              input: string;
          }) => string)
            • (ctx): string

            • Parameters

              • ctx: {
                    error: ZodError<any>;
                    input: string;
                }
                • error: ZodError<any>
                • input: string

              Returns string

        Returns ZodCatch<ZodString>

  • cidr: ((options?: string | {
        message?: string;
        version?: IpVersion;
    }) => ZodString)
      • (options?): ZodString

      • Parameters

        • Optionaloptions: string | {
              message?: string;
              version?: IpVersion;
          }

        Returns ZodString

  • cuid: ((message?: ErrMessage) => ZodString)
      • (message?): ZodString

      • Parameters

        • Optionalmessage: ErrMessage

        Returns ZodString

  • cuid2: ((message?: ErrMessage) => ZodString)
      • (message?): ZodString

      • Parameters

        • Optionalmessage: ErrMessage

        Returns ZodString

  • date: ((message?: string) => ZodString)
      • (message?): ZodString

      • Parameters

        • Optionalmessage: string

        Returns ZodString

  • datetime: ((options?: string | {
        local?: boolean;
        message?: string;
        offset?: boolean;
        precision?: null | number;
    }) => ZodString)
      • (options?): ZodString

      • Parameters

        • Optionaloptions: string | {
              local?: boolean;
              message?: string;
              offset?: boolean;
              precision?: null | number;
          }

        Returns ZodString

  • default: {
        (def: string): ZodDefault<ZodString>;
        (def: (() => string)): ZodDefault<ZodString>;
    }
      • (def): ZodDefault<ZodString>

      • Parameters

        • def: string

        Returns ZodDefault<ZodString>

      • (def): ZodDefault<ZodString>

      • Parameters

        • def: (() => string)
            • (): string

            • Returns string

        Returns ZodDefault<ZodString>

  • describe: ((description: string) => this)
      • (description): this

      • Parameters

        • description: string

        Returns this

  • description: undefined | string
  • duration: ((message?: ErrMessage) => ZodString)
      • (message?): ZodString

      • Parameters

        • Optionalmessage: ErrMessage

        Returns ZodString

  • email: ((message?: ErrMessage) => ZodString)
      • (message?): ZodString

      • Parameters

        • Optionalmessage: ErrMessage

        Returns ZodString

  • emoji: ((message?: ErrMessage) => ZodString)
      • (message?): ZodString

      • Parameters

        • Optionalmessage: ErrMessage

        Returns ZodString

  • endsWith: ((value: string, message?: ErrMessage) => ZodString)
      • (value, message?): ZodString

      • Parameters

        • value: string
        • Optionalmessage: ErrMessage

        Returns ZodString

  • includes: ((value: string, options?: {
        message?: string;
        position?: number;
    }) => ZodString)
      • (value, options?): ZodString

      • Parameters

        • value: string
        • Optionaloptions: {
              message?: string;
              position?: number;
          }
          • Optionalmessage?: string
          • Optionalposition?: number

        Returns ZodString

  • ip: ((options?: string | {
        message?: string;
        version?: IpVersion;
    }) => ZodString)
      • (options?): ZodString

      • Parameters

        • Optionaloptions: string | {
              message?: string;
              version?: IpVersion;
          }

        Returns ZodString

  • isBase64: boolean
  • isBase64url: boolean
  • isCIDR: boolean
  • isCUID: boolean
  • isCUID2: boolean
  • isDate: boolean
  • isDatetime: boolean
  • isDuration: boolean
  • isEmail: boolean
  • isEmoji: boolean
  • isIP: boolean
  • isNANOID: boolean
  • isNullable: (() => boolean)
      • (): boolean

      • Returns boolean

  • isOptional: (() => boolean)
      • (): boolean

      • Returns boolean

  • isTime: boolean
  • isULID: boolean
  • isURL: boolean
  • isUUID: boolean
  • jwt: ((options?: {
        alg?: string;
        message?: string;
    }) => ZodString)
      • (options?): ZodString

      • Parameters

        • Optionaloptions: {
              alg?: string;
              message?: string;
          }
          • Optionalalg?: string
          • Optionalmessage?: string

        Returns ZodString

  • length: ((len: number, message?: ErrMessage) => ZodString)
      • (len, message?): ZodString

      • Parameters

        • len: number
        • Optionalmessage: ErrMessage

        Returns ZodString

  • max: ((maxLength: number, message?: ErrMessage) => ZodString)
      • (maxLength, message?): ZodString

      • Parameters

        • maxLength: number
        • Optionalmessage: ErrMessage

        Returns ZodString

  • maxLength: null | number
  • min: ((minLength: number, message?: ErrMessage) => ZodString)
      • (minLength, message?): ZodString

      • Parameters

        • minLength: number
        • Optionalmessage: ErrMessage

        Returns ZodString

  • minLength: null | number
  • nanoid: ((message?: ErrMessage) => ZodString)
      • (message?): ZodString

      • Parameters

        • Optionalmessage: ErrMessage

        Returns ZodString

  • nonempty: ((message?: ErrMessage) => ZodString)
      • (message?): ZodString

      • Equivalent to .min(1)

        Parameters

        • Optionalmessage: ErrMessage

        Returns ZodString

  • nullable: (() => ZodNullable<ZodString>)
      • (): ZodNullable<ZodString>

      • Returns ZodNullable<ZodString>

  • nullish: (() => ZodOptional<ZodNullable<ZodString>>)
      • (): ZodOptional<ZodNullable<ZodString>>

      • Returns ZodOptional<ZodNullable<ZodString>>

  • optional: (() => ZodOptional<ZodString>)
      • (): ZodOptional<ZodString>

      • Returns ZodOptional<ZodString>

  • or: (<T>(option: T) => ZodUnion<[ZodString, T]>)
      • <T>(option): ZodUnion<[ZodString, T]>

      • Type Parameters

        • T extends ZodTypeAny

        Parameters

        • option: T

        Returns ZodUnion<[ZodString, T]>

  • parse: ((data: unknown, params?: InexactPartial<ParseParams>) => string)
      • (data, params?): string

      • Parameters

        • data: unknown
        • Optionalparams: InexactPartial<ParseParams>

        Returns string

  • parseAsync: ((data: unknown, params?: InexactPartial<ParseParams>) => Promise<string>)
      • (data, params?): Promise<string>

      • Parameters

        • data: unknown
        • Optionalparams: InexactPartial<ParseParams>

        Returns Promise<string>

  • pipe: (<T>(target: T) => ZodPipeline<ZodString, T>)
      • <T>(target): ZodPipeline<ZodString, T>

      • Type Parameters

        • T extends ZodTypeAny

        Parameters

        • target: T

        Returns ZodPipeline<ZodString, T>

  • promise: (() => ZodPromise<ZodString>)
      • (): ZodPromise<ZodString>

      • Returns ZodPromise<ZodString>

  • readonly: (() => ZodReadonly<ZodString>)
      • (): ZodReadonly<ZodString>

      • Returns ZodReadonly<ZodString>

  • refine: {
        <RefinedOutput>(check: ((arg: string) => arg is RefinedOutput), message?: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg: string) => Partial<Omit<ZodCustomIssue, "code">>)): ZodEffects<ZodString, RefinedOutput, string>;
        (check: ((arg: string) => unknown), message?: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg: string) => Partial<Omit<ZodCustomIssue, "code">>)): ZodEffects<ZodString, string, string>;
    }
      • <RefinedOutput>(check, message?): ZodEffects<ZodString, RefinedOutput, string>

      • Type Parameters

        • RefinedOutput extends string

        Parameters

        • check: ((arg: string) => arg is RefinedOutput)
        • Optionalmessage: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg: string) => Partial<Omit<ZodCustomIssue, "code">>)

        Returns ZodEffects<ZodString, RefinedOutput, string>

      • (check, message?): ZodEffects<ZodString, string, string>

      • Parameters

        • check: ((arg: string) => unknown)
            • (arg): unknown

            • Parameters

              • arg: string

              Returns unknown

        • Optionalmessage: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg: string) => Partial<Omit<ZodCustomIssue, "code">>)

        Returns ZodEffects<ZodString, string, string>

  • refinement: {
        <RefinedOutput>(check: ((arg: string) => arg is RefinedOutput), refinementData: IssueData | ((arg: string, ctx: RefinementCtx) => IssueData)): ZodEffects<ZodString, RefinedOutput, string>;
        (check: ((arg: string) => boolean), refinementData: IssueData | ((arg: string, ctx: RefinementCtx) => IssueData)): ZodEffects<ZodString, string, string>;
    }
      • <RefinedOutput>(check, refinementData): ZodEffects<ZodString, RefinedOutput, string>

      • Type Parameters

        • RefinedOutput extends string

        Parameters

        • check: ((arg: string) => arg is RefinedOutput)
        • refinementData: IssueData | ((arg: string, ctx: RefinementCtx) => IssueData)

        Returns ZodEffects<ZodString, RefinedOutput, string>

      • (check, refinementData): ZodEffects<ZodString, string, string>

      • Parameters

        • check: ((arg: string) => boolean)
            • (arg): boolean

            • Parameters

              • arg: string

              Returns boolean

        • refinementData: IssueData | ((arg: string, ctx: RefinementCtx) => IssueData)

        Returns ZodEffects<ZodString, string, string>

  • regex: ((regex: RegExp, message?: ErrMessage) => ZodString)
      • (regex, message?): ZodString

      • Parameters

        • regex: RegExp
        • Optionalmessage: ErrMessage

        Returns ZodString

  • safeParse: ((data: unknown, params?: InexactPartial<ParseParams>) => SafeParseReturnType<string, string>)
      • (data, params?): SafeParseReturnType<string, string>

      • Parameters

        • data: unknown
        • Optionalparams: InexactPartial<ParseParams>

        Returns SafeParseReturnType<string, string>

  • safeParseAsync: ((data: unknown, params?: InexactPartial<ParseParams>) => Promise<SafeParseReturnType<string, string>>)
      • (data, params?): Promise<SafeParseReturnType<string, string>>

      • Parameters

        • data: unknown
        • Optionalparams: InexactPartial<ParseParams>

        Returns Promise<SafeParseReturnType<string, string>>

  • spa: ((data: unknown, params?: InexactPartial<ParseParams>) => Promise<SafeParseReturnType<string, string>>)
      • (data, params?): Promise<SafeParseReturnType<string, string>>

      • Alias of safeParseAsync

        Parameters

        • data: unknown
        • Optionalparams: InexactPartial<ParseParams>

        Returns Promise<SafeParseReturnType<string, string>>

  • startsWith: ((value: string, message?: ErrMessage) => ZodString)
      • (value, message?): ZodString

      • Parameters

        • value: string
        • Optionalmessage: ErrMessage

        Returns ZodString

  • superRefine: {
        <RefinedOutput>(refinement: ((arg: string, ctx: RefinementCtx) => arg is RefinedOutput)): ZodEffects<ZodString, RefinedOutput, string>;
        (refinement: ((arg: string, ctx: RefinementCtx) => void)): ZodEffects<ZodString, string, string>;
        (refinement: ((arg: string, ctx: RefinementCtx) => Promise<void>)): ZodEffects<ZodString, string, string>;
    }
      • <RefinedOutput>(refinement): ZodEffects<ZodString, RefinedOutput, string>

      • Type Parameters

        • RefinedOutput extends string

        Parameters

        Returns ZodEffects<ZodString, RefinedOutput, string>

      • (refinement): ZodEffects<ZodString, string, string>

      • Parameters

        • refinement: ((arg: string, ctx: RefinementCtx) => void)
            • (arg, ctx): void

            • Parameters

              • arg: string
              • ctx: RefinementCtx

              Returns void

        Returns ZodEffects<ZodString, string, string>

      • (refinement): ZodEffects<ZodString, string, string>

      • Parameters

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

            • Parameters

              • arg: string
              • ctx: RefinementCtx

              Returns Promise<void>

        Returns ZodEffects<ZodString, string, string>

  • time: ((options?: string | {
        message?: string;
        precision?: null | number;
    }) => ZodString)
      • (options?): ZodString

      • Parameters

        • Optionaloptions: string | {
              message?: string;
              precision?: null | number;
          }

        Returns ZodString

  • toLowerCase: (() => ZodString)
      • (): ZodString

      • Returns ZodString

  • toUpperCase: (() => ZodString)
      • (): ZodString

      • Returns ZodString

  • transform: (<NewOut>(transform: ((arg: string, ctx: RefinementCtx) => NewOut | Promise<NewOut>)) => ZodEffects<ZodString, NewOut, string>)
      • <NewOut>(transform): ZodEffects<ZodString, NewOut, string>

      • Type Parameters

        • NewOut

        Parameters

        • transform: ((arg: string, ctx: RefinementCtx) => NewOut | Promise<NewOut>)

        Returns ZodEffects<ZodString, NewOut, string>

  • trim: (() => ZodString)
      • (): ZodString

      • Returns ZodString

  • ulid: ((message?: ErrMessage) => ZodString)
      • (message?): ZodString

      • Parameters

        • Optionalmessage: ErrMessage

        Returns ZodString

  • url: ((message?: ErrMessage) => ZodString)
      • (message?): ZodString

      • Parameters

        • Optionalmessage: ErrMessage

        Returns ZodString

  • uuid: ((message?: ErrMessage) => ZodString)
      • (message?): ZodString

      • Parameters

        • Optionalmessage: ErrMessage

        Returns ZodString

  • ~standard: Props<string, string>
  • ~validate: ((data: unknown) => Result<string> | Promise<Result<string>>)
      • (data): Result<string> | Promise<Result<string>>

      • Parameters

        • data: unknown

        Returns Result<string> | Promise<Result<string>>

Settings

Member Visibility