Class ZodString

Hierarchy (View Summary)

Zod.ZodType<string, Zod.ZodStringDef>
- ZodString

Constructors

constructor

new ZodString(def: Zod.ZodStringDef): Zod.ZodString
Parameters
- def: Zod.ZodStringDef
Returns Zod.ZodString
Inherited from ZodType.constructor

Properties

`Readonly`_def

_def: Zod.ZodStringDef

`Readonly`_input

_input: string

`Readonly`_output

_output: string

`Readonly`_type

_type: string

spa

spa: (
data: unknown,
params?: Partial<Zod.ParseParams>,
) => Promise<Zod.SafeParseReturnType<string, string>>

Alias of safeParseAsync

`Static`create

create: (
    params?: {
        description?: string;
        errorMap?: Zod.ZodErrorMap;
        invalid_type_error?: string;
        required_error?: string;
    } & { coerce?: true },
) => Zod.ZodString

Accessors

description

get description(): undefined | string
Returns undefined | string
Inherited from ZodType.description

isCUID

get isCUID(): boolean
Returns boolean

isCUID2

get isCUID2(): boolean
Returns boolean

isDatetime

get isDatetime(): boolean
Returns boolean

isEmail

get isEmail(): boolean
Returns boolean

isEmoji

get isEmoji(): boolean
Returns boolean

isIP

get isIP(): boolean
Returns boolean

isULID

get isULID(): boolean
Returns boolean

isURL

get isURL(): boolean
Returns boolean

isUUID

get isUUID(): boolean
Returns boolean

maxLength

get maxLength(): null | number
Returns null | number

minLength

get minLength(): null | number
Returns null | number

Methods

_addCheck

_addCheck(check: Zod.ZodStringCheck): Zod.ZodString
Parameters
- check: Zod.ZodStringCheck
Returns Zod.ZodString

_getOrReturnCtx

_getOrReturnCtx(input: Zod.ParseInput, ctx?: Zod.ParseContext): Zod.ParseContext
Parameters
- input: Zod.ParseInput
- Optionalctx: Zod.ParseContext
Returns Zod.ParseContext
Inherited from ZodType._getOrReturnCtx

_getType

_getType(input: Zod.ParseInput): string
Parameters
- input: Zod.ParseInput
Returns string
Inherited from ZodType._getType

_parse

_parse(input: Zod.ParseInput): Zod.ParseReturnType<string>
Parameters
- input: Zod.ParseInput
Returns Zod.ParseReturnType<string>
Overrides ZodType._parse

_parseAsync

_parseAsync(input: Zod.ParseInput): Zod.AsyncParseReturnType<string>
Parameters
- input: Zod.ParseInput
Returns Zod.AsyncParseReturnType<string>
Inherited from ZodType._parseAsync

_parseSync

_parseSync(input: Zod.ParseInput): Zod.SyncParseReturnType<string>
Parameters
- input: Zod.ParseInput
Returns Zod.SyncParseReturnType<string>
Inherited from ZodType._parseSync

_processInputParams

_processInputParams(
input: Zod.ParseInput,
): { ctx: Zod.ParseContext; status: Zod.ParseStatus }
Parameters
- input: Zod.ParseInput
Returns { ctx: Zod.ParseContext; status: Zod.ParseStatus }
Inherited from ZodType._processInputParams

_refinement

_refinement(
refinement: (arg: string, ctx: Zod.RefinementCtx) => any,
): Zod.ZodEffects<Zod.ZodString, string, string>
Parameters
- refinement: (arg: string, ctx: Zod.RefinementCtx) => any
Returns Zod.ZodEffects<Zod.ZodString, string, string>
Inherited from ZodType._refinement

and

and<T extends Zod.ZodTypeAny>(
incoming: T,
): Zod.ZodIntersection<Zod.ZodString, T>
Type Parameters
- T extends Zod.ZodTypeAny
Parameters
- incoming: T
Returns Zod.ZodIntersection<Zod.ZodString, T>
Inherited from ZodType.and

array

array(): Zod.ZodArray<Zod.ZodString>
Returns Zod.ZodArray<Zod.ZodString>
Inherited from ZodType.array

brand

brand<B extends string | number | symbol>(
brand?: B,
): Zod.ZodBranded<Zod.ZodString, B>
Type Parameters
- B extends string | number | symbol
Parameters
- Optionalbrand: B
Returns Zod.ZodBranded<Zod.ZodString, B>
Inherited from ZodType.brand

catch

catch(def: string): Zod.ZodCatch<Zod.ZodString>
Parameters
- def: string
Returns Zod.ZodCatch<Zod.ZodString>
Inherited from ZodType.catch
catch(
def: (ctx: { error: Zod.ZodError; input: string }) => string,
): Zod.ZodCatch<Zod.ZodString>
Parameters
- def: (ctx: { error: Zod.ZodError; input: string }) => string
Returns Zod.ZodCatch<Zod.ZodString>
Inherited from ZodType.catch

cuid

cuid(message?: ErrMessage): Zod.ZodString
Parameters
- Optionalmessage: ErrMessage
Returns Zod.ZodString

cuid2

cuid2(message?: ErrMessage): Zod.ZodString
Parameters
- Optionalmessage: ErrMessage
Returns Zod.ZodString

datetime

datetime(
    options?:
        | string
        | { message?: string; offset?: boolean; precision?: null
        | number },
): Zod.ZodString
Parameters
- Optionaloptions: string | { message?: string; offset?: boolean; precision?: null | number }
Returns Zod.ZodString

default

default(def: string): Zod.ZodDefault<Zod.ZodString>
Parameters
- def: string
Returns Zod.ZodDefault<Zod.ZodString>
Inherited from ZodType.default
default(def: () => string): Zod.ZodDefault<Zod.ZodString>
Parameters
- def: () => string
Returns Zod.ZodDefault<Zod.ZodString>
Inherited from ZodType.default

describe

describe(description: string): this
Parameters
- description: string
Returns this
Inherited from ZodType.describe

email

email(message?: ErrMessage): Zod.ZodString
Parameters
- Optionalmessage: ErrMessage
Returns Zod.ZodString

emoji

emoji(message?: ErrMessage): Zod.ZodString
Parameters
- Optionalmessage: ErrMessage
Returns Zod.ZodString

endsWith

endsWith(value: string, message?: ErrMessage): Zod.ZodString
Parameters
- value: string
- Optionalmessage: ErrMessage
Returns Zod.ZodString

includes

includes(
value: string,
options?: { message?: string; position?: number },
): Zod.ZodString
Parameters
- value: string
- Optionaloptions: { message?: string; position?: number }
Returns Zod.ZodString

ip

ip(
options?: string | { message?: string; version?: "v4" | "v6" },
): Zod.ZodString
Parameters
- Optionaloptions: string | { message?: string; version?: "v4" | "v6" }
Returns Zod.ZodString

isNullable

isNullable(): boolean
Returns boolean
Inherited from ZodType.isNullable

isOptional

isOptional(): boolean
Returns boolean
Inherited from ZodType.isOptional

length

length(len: number, message?: ErrMessage): Zod.ZodString
Parameters
- len: number
- Optionalmessage: ErrMessage
Returns Zod.ZodString

max

max(maxLength: number, message?: ErrMessage): Zod.ZodString
Parameters
- maxLength: number
- Optionalmessage: ErrMessage
Returns Zod.ZodString

min

min(minLength: number, message?: ErrMessage): Zod.ZodString
Parameters
- minLength: number
- Optionalmessage: ErrMessage
Returns Zod.ZodString

nonempty

nonempty(message?: ErrMessage): Zod.ZodString
Parameters
- Optionalmessage: ErrMessage
Returns Zod.ZodString
Deprecated
Use z.string().min(1) instead.

See
ZodString.min

or

or<T extends Zod.ZodTypeAny>(option: T): Zod.ZodUnion<[Zod.ZodString, T]>
Type Parameters
- T extends Zod.ZodTypeAny
Parameters
- option: T
Returns Zod.ZodUnion<[Zod.ZodString, T]>
Inherited from ZodType.or

parse

parse(data: unknown, params?: Partial<Zod.ParseParams>): string
Parameters
- data: unknown
- Optionalparams: Partial<Zod.ParseParams>
Returns string
Inherited from ZodType.parse

parseAsync

parseAsync(data: unknown, params?: Partial<Zod.ParseParams>): Promise<string>
Parameters
- data: unknown
- Optionalparams: Partial<Zod.ParseParams>
Returns Promise<string>
Inherited from ZodType.parseAsync

pipe

pipe<T extends Zod.ZodTypeAny>(target: T): Zod.ZodPipeline<Zod.ZodString, T>
Type Parameters
- T extends Zod.ZodTypeAny
Parameters
- target: T
Returns Zod.ZodPipeline<Zod.ZodString, T>
Inherited from ZodType.pipe

promise

promise(): Zod.ZodPromise<Zod.ZodString>
Returns Zod.ZodPromise<Zod.ZodString>
Inherited from ZodType.promise

readonly

readonly(): Zod.ZodReadonly<Zod.ZodString>
Returns Zod.ZodReadonly<Zod.ZodString>
Inherited from ZodType.readonly

refine

refine<RefinedOutput extends string>(
    check: (arg: string) => arg is RefinedOutput,
    message?:
        | string
        | Partial<Omit<Zod.ZodCustomIssue, "code">>
        | ((arg: string) => Zod.CustomErrorParams),
): Zod.ZodEffects<Zod.ZodString, RefinedOutput, string>
Type Parameters
- RefinedOutput extends string
Parameters
- check: (arg: string) => arg is RefinedOutput
- Optionalmessage:
      | string
      | Partial<Omit<Zod.ZodCustomIssue, "code">>
      | ((arg: string) => Zod.CustomErrorParams)
Returns Zod.ZodEffects<Zod.ZodString, RefinedOutput, string>
Inherited from ZodType.refine
refine(
    check: (arg: string) => unknown,
    message?:
        | string
        | Partial<Omit<Zod.ZodCustomIssue, "code">>
        | ((arg: string) => Zod.CustomErrorParams),
): Zod.ZodEffects<Zod.ZodString, string, string>
Parameters
- check: (arg: string) => unknown
- Optionalmessage:
      | string
      | Partial<Omit<Zod.ZodCustomIssue, "code">>
      | ((arg: string) => Zod.CustomErrorParams)
Returns Zod.ZodEffects<Zod.ZodString, string, string>
Inherited from ZodType.refine

refinement<RefinedOutput extends string>(
    check: (arg: string) => arg is RefinedOutput,
    refinementData:
        | Zod.IssueData
        | ((arg: string, ctx: Zod.RefinementCtx) => Zod.IssueData),
): Zod.ZodEffects<Zod.ZodString, RefinedOutput, string>
Type Parameters
- RefinedOutput extends string
Parameters
- check: (arg: string) => arg is RefinedOutput
- refinementData: Zod.IssueData | ((arg: string, ctx: Zod.RefinementCtx) => Zod.IssueData)
Returns Zod.ZodEffects<Zod.ZodString, RefinedOutput, string>
Inherited from ZodType.refinement
refinement(
    check: (arg: string) => boolean,
    refinementData:
        | Zod.IssueData
        | ((arg: string, ctx: Zod.RefinementCtx) => Zod.IssueData),
): Zod.ZodEffects<Zod.ZodString, string, string>
Parameters
- check: (arg: string) => boolean
- refinementData: Zod.IssueData | ((arg: string, ctx: Zod.RefinementCtx) => Zod.IssueData)
Returns Zod.ZodEffects<Zod.ZodString, string, string>
Inherited from ZodType.refinement

regex

regex(regex: RegExp, message?: ErrMessage): Zod.ZodString
Parameters
- regex: RegExp
- Optionalmessage: ErrMessage
Returns Zod.ZodString

safeParse

safeParse(
data: unknown,
params?: Partial<Zod.ParseParams>,
): Zod.SafeParseReturnType<string, string>
Parameters
- data: unknown
- Optionalparams: Partial<Zod.ParseParams>
Returns Zod.SafeParseReturnType<string, string>
Inherited from ZodType.safeParse

safeParseAsync

safeParseAsync(
data: unknown,
params?: Partial<Zod.ParseParams>,
): Promise<Zod.SafeParseReturnType<string, string>>
Parameters
- data: unknown
- Optionalparams: Partial<Zod.ParseParams>
Returns Promise<Zod.SafeParseReturnType<string, string>>
Inherited from ZodType.safeParseAsync

startsWith

startsWith(value: string, message?: ErrMessage): Zod.ZodString
Parameters
- value: string
- Optionalmessage: ErrMessage
Returns Zod.ZodString

superRefine

superRefine<RefinedOutput extends string>(
    refinement: (
        arg: string,
        ctx: Zod.RefinementCtx,
    ) => arg is RefinedOutput,
): Zod.ZodEffects<Zod.ZodString, RefinedOutput, string>
Type Parameters
- RefinedOutput extends string
Parameters
- refinement: (arg: string, ctx: Zod.RefinementCtx) => arg is RefinedOutput
Returns Zod.ZodEffects<Zod.ZodString, RefinedOutput, string>
Inherited from ZodType.superRefine
superRefine(
refinement: (arg: string, ctx: Zod.RefinementCtx) => void,
): Zod.ZodEffects<Zod.ZodString, string, string>
Parameters
- refinement: (arg: string, ctx: Zod.RefinementCtx) => void
Returns Zod.ZodEffects<Zod.ZodString, string, string>
Inherited from ZodType.superRefine
superRefine(
refinement: (arg: string, ctx: Zod.RefinementCtx) => Promise<void>,
): Zod.ZodEffects<Zod.ZodString, string, string>
Parameters
- refinement: (arg: string, ctx: Zod.RefinementCtx) => Promise<void>
Returns Zod.ZodEffects<Zod.ZodString, string, string>
Inherited from ZodType.superRefine

toLowerCase

toLowerCase(): Zod.ZodString
Returns Zod.ZodString

toUpperCase

toUpperCase(): Zod.ZodString
Returns Zod.ZodString

transform

transform<NewOut>(
    transform: (
        arg: string,
        ctx: Zod.RefinementCtx,
    ) => NewOut | Promise<NewOut>,
): Zod.ZodEffects<Zod.ZodString, NewOut>
Type Parameters
- NewOut
Parameters
- transform: (arg: string, ctx: Zod.RefinementCtx) => NewOut | Promise<NewOut>
Returns Zod.ZodEffects<Zod.ZodString, NewOut>
Inherited from ZodType.transform

trim

trim(): Zod.ZodString
Returns Zod.ZodString

ulid

ulid(message?: ErrMessage): Zod.ZodString
Parameters
- Optionalmessage: ErrMessage
Returns Zod.ZodString

url

url(message?: ErrMessage): Zod.ZodString
Parameters
- Optionalmessage: ErrMessage
Returns Zod.ZodString

uuid

uuid(message?: ErrMessage): Zod.ZodString
Parameters
- Optionalmessage: ErrMessage
Returns Zod.ZodString

Class ZodString

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Zod.ZodString

Properties

Readonly_def

Readonly_input

Readonly_output

Readonly_type

spa

Staticcreate

Accessors

description

Returns undefined | string

isCUID

Returns boolean

isCUID2

Returns boolean

isDatetime

Returns boolean

isEmail

Returns boolean

isEmoji

Returns boolean

isIP

Returns boolean

isULID

Returns boolean

isURL

Returns boolean

isUUID

Returns boolean

maxLength

Returns null | number

minLength

Returns null | number

Methods

_addCheck

Parameters

Returns Zod.ZodString

_getOrReturnCtx

Parameters

Returns Zod.ParseContext

_getType

Parameters

Returns string

_parse

Parameters

Returns Zod.ParseReturnType<string>

_parseAsync

Parameters

Returns Zod.AsyncParseReturnType<string>

_parseSync

Parameters

Returns Zod.SyncParseReturnType<string>

_processInputParams

Parameters

Returns { ctx: Zod.ParseContext; status: Zod.ParseStatus }

_refinement

Parameters

Returns Zod.ZodEffects<Zod.ZodString, string, string>

and

Type Parameters

Parameters

Returns Zod.ZodIntersection<Zod.ZodString, T>

array

Returns Zod.ZodArray<Zod.ZodString>

brand

Type Parameters

Parameters

Returns Zod.ZodBranded<Zod.ZodString, B>

catch

Parameters

`Readonly`_def

`Readonly`_input

`Readonly`_output

`Readonly`_type

`Static`create