Class ZodString

Hierarchy (View Summary)

ZodType<string, ZodStringDef, string>
- ZodString

Constructors

constructor

new ZodString(def: ZodStringDef): ZodString
Parameters
- def: ZodStringDef
Returns ZodString
Inherited from ZodType.constructor
- Defined in node_modules/zod/v3/types.d.cts:79

Properties

`Readonly`_def

_def: ZodStringDef

`Readonly`_input

_input: string

`Readonly`_output

_output: string

`Readonly`_type

_type: string

~standard

"~standard": Props<string, string>

spa

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

Alias of safeParseAsync

`Static`create

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

Accessors

description

get description(): string | undefined
Returns string | undefined
Inherited from ZodType.description
- Defined in node_modules/zod/v3/types.d.cts:53

isBase64

get isBase64(): boolean
Returns boolean
- Defined in node_modules/zod/v3/types.d.cts:279

isBase64url

get isBase64url(): boolean
Returns boolean
- Defined in node_modules/zod/v3/types.d.cts:280

isCIDR

get isCIDR(): boolean
Returns boolean
- Defined in node_modules/zod/v3/types.d.cts:278

isCUID

get isCUID(): boolean
Returns boolean
- Defined in node_modules/zod/v3/types.d.cts:274

isCUID2

get isCUID2(): boolean
Returns boolean
- Defined in node_modules/zod/v3/types.d.cts:275

isDate

get isDate(): boolean
Returns boolean
- Defined in node_modules/zod/v3/types.d.cts:266

isDatetime

get isDatetime(): boolean
Returns boolean
- Defined in node_modules/zod/v3/types.d.cts:265

isDuration

get isDuration(): boolean
Returns boolean
- Defined in node_modules/zod/v3/types.d.cts:268

isEmail

get isEmail(): boolean
Returns boolean
- Defined in node_modules/zod/v3/types.d.cts:269

isEmoji

get isEmoji(): boolean
Returns boolean
- Defined in node_modules/zod/v3/types.d.cts:271

isIP

get isIP(): boolean
Returns boolean
- Defined in node_modules/zod/v3/types.d.cts:277

isNANOID

get isNANOID(): boolean
Returns boolean
- Defined in node_modules/zod/v3/types.d.cts:273

isTime

get isTime(): boolean
Returns boolean
- Defined in node_modules/zod/v3/types.d.cts:267

isULID

get isULID(): boolean
Returns boolean
- Defined in node_modules/zod/v3/types.d.cts:276

isURL

get isURL(): boolean
Returns boolean
- Defined in node_modules/zod/v3/types.d.cts:270

isUUID

get isUUID(): boolean
Returns boolean
- Defined in node_modules/zod/v3/types.d.cts:272

maxLength

get maxLength(): number | null
Returns number | null
- Defined in node_modules/zod/v3/types.d.cts:282

minLength

get minLength(): number | null
Returns number | null
- Defined in node_modules/zod/v3/types.d.cts:281

Methods

_addCheck

_addCheck(check: ZodStringCheck): ZodString
Parameters
- check: ZodStringCheck
Returns ZodString
- Defined in node_modules/zod/v3/types.d.cts:213

_getOrReturnCtx

_getOrReturnCtx(input: ParseInput, ctx?: ParseContext): ParseContext
Parameters
- input: ParseInput
- Optionalctx: ParseContext
Returns ParseContext
Inherited from ZodType._getOrReturnCtx
- Defined in node_modules/zod/v3/types.d.cts:57

_getType

_getType(input: ParseInput): string
Parameters
- input: ParseInput
Returns string
Inherited from ZodType._getType
- Defined in node_modules/zod/v3/types.d.cts:56

_parse

_parse(input: ParseInput): ParseReturnType<string>
Parameters
- input: ParseInput
Returns ParseReturnType<string>
Overrides ZodType._parse
- Defined in node_modules/zod/v3/types.d.cts:211

_parseAsync

_parseAsync(input: ParseInput): AsyncParseReturnType<string>
Parameters
- input: ParseInput
Returns AsyncParseReturnType<string>
Inherited from ZodType._parseAsync
- Defined in node_modules/zod/v3/types.d.cts:63

_parseSync

_parseSync(input: ParseInput): SyncParseReturnType<string>
Parameters
- input: ParseInput
Returns SyncParseReturnType<string>
Inherited from ZodType._parseSync
- Defined in node_modules/zod/v3/types.d.cts:62

_processInputParams

_processInputParams(
input: ParseInput,
): { ctx: ParseContext; status: ParseStatus }
Parameters
- input: ParseInput
Returns { ctx: ParseContext; status: ParseStatus }
Inherited from ZodType._processInputParams
- Defined in node_modules/zod/v3/types.d.cts:58

_refinement

_refinement(
refinement: (arg: string, ctx: RefinementCtx) => any,
): ZodEffects<ZodString, string, string>
Parameters
- refinement: (arg: string, ctx: RefinementCtx) => any
Returns ZodEffects<ZodString, string, string>
Inherited from ZodType._refinement
- Defined in node_modules/zod/v3/types.d.cts:75

`Protected`_regex

_regex(
    regex: RegExp,
    validation: StringValidation,
    message?: ErrMessage,
): ZodEffects<ZodString, string, string>
Parameters
- regex: RegExp
- validation: StringValidation
- Optionalmessage: ErrMessage
Returns ZodEffects<ZodString, string, string>
- Defined in node_modules/zod/v3/types.d.cts:212

~validate

"~validate"(data: unknown): Result<string> | Promise<Result<string>>
Parameters
- data: unknown
Returns Result<string> | Promise<Result<string>>
Inherited from ZodType.~validate
- Defined in node_modules/zod/v3/types.d.cts:66

and

and<T extends ZodTypeAny>(incoming: T): ZodIntersection<ZodString, T>
Type Parameters
- T extends ZodTypeAny
Parameters
- incoming: T
Returns ZodIntersection<ZodString, T>
Inherited from ZodType.and
- Defined in node_modules/zod/v3/types.d.cts:86

array

array(): ZodArray<ZodString>
Returns ZodArray<ZodString>
Inherited from ZodType.array
- Defined in node_modules/zod/v3/types.d.cts:83

base64

base64(message?: ErrMessage): ZodString
Parameters
- Optionalmessage: ErrMessage
Returns ZodString
- Defined in node_modules/zod/v3/types.d.cts:222

base64url

base64url(message?: ErrMessage): ZodString
Parameters
- Optionalmessage: ErrMessage
Returns ZodString
- Defined in node_modules/zod/v3/types.d.cts:223

brand

brand<B extends string | number | symbol>(brand?: B): ZodBranded<ZodString, B>
Type Parameters
- B extends string | number | symbol
Parameters
- Optionalbrand: B
Returns ZodBranded<ZodString, B>
Inherited from ZodType.brand
- Defined in node_modules/zod/v3/types.d.cts:90

catch

catch(def: string): ZodCatch<ZodString>
Parameters
- def: string
Returns ZodCatch<ZodString>
Inherited from ZodType.catch
- Defined in node_modules/zod/v3/types.d.cts:91
catch(
def: (ctx: { error: ZodError; input: string }) => string,
): ZodCatch<ZodString>
Parameters
- def: (ctx: { error: ZodError; input: string }) => string
Returns ZodCatch<ZodString>
Inherited from ZodType.catch
- Defined in node_modules/zod/v3/types.d.cts:92

cidr

cidr(options?: string | { message?: string; version?: IpVersion }): ZodString
Parameters
- Optionaloptions: string | { message?: string; version?: IpVersion }
Returns ZodString
- Defined in node_modules/zod/v3/types.d.cts:232

cuid

cuid(message?: ErrMessage): ZodString
Parameters
- Optionalmessage: ErrMessage
Returns ZodString
- Defined in node_modules/zod/v3/types.d.cts:219

cuid2

cuid2(message?: ErrMessage): ZodString
Parameters
- Optionalmessage: ErrMessage
Returns ZodString
- Defined in node_modules/zod/v3/types.d.cts:220

date

date(message?: string): ZodString
Parameters
- Optionalmessage: string
Returns ZodString
- Defined in node_modules/zod/v3/types.d.cts:242

datetime

datetime(
    options?:
        | string
        | {
            local?: boolean;
            message?: string;
            offset?: boolean;
            precision?: number
            | null;
        },
): ZodString
Parameters
- Optionaloptions:
      | string
      | {
          local?: boolean;
          message?: string;
          offset?: boolean;
          precision?: number
          | null;
      }
Returns ZodString
- Defined in node_modules/zod/v3/types.d.cts:236

default

default(def: string): ZodDefault<ZodString>
Parameters
- def: string
Returns ZodDefault<ZodString>
Inherited from ZodType.default
- Defined in node_modules/zod/v3/types.d.cts:88
default(def: () => string): ZodDefault<ZodString>
Parameters
- def: () => string
Returns ZodDefault<ZodString>
Inherited from ZodType.default
- Defined in node_modules/zod/v3/types.d.cts:89

describe

describe(description: string): this
Parameters
- description: string
Returns this
Inherited from ZodType.describe
- Defined in node_modules/zod/v3/types.d.cts:96

duration

duration(message?: ErrMessage): ZodString
Parameters
- Optionalmessage: ErrMessage
Returns ZodString
- Defined in node_modules/zod/v3/types.d.cts:247

email

email(message?: ErrMessage): ZodString
Parameters
- Optionalmessage: ErrMessage
Returns ZodString
- Defined in node_modules/zod/v3/types.d.cts:214

emoji

emoji(message?: ErrMessage): ZodString
Parameters
- Optionalmessage: ErrMessage
Returns ZodString
- Defined in node_modules/zod/v3/types.d.cts:216

endsWith

endsWith(value: string, message?: ErrMessage): ZodString
Parameters
- value: string
- Optionalmessage: ErrMessage
Returns ZodString
- Defined in node_modules/zod/v3/types.d.cts:254

includes

includes(
value: string,
options?: { message?: string; position?: number },
): ZodString
Parameters
- value: string
- Optionaloptions: { message?: string; position?: number }
Returns ZodString
- Defined in node_modules/zod/v3/types.d.cts:249

ip

ip(options?: string | { message?: string; version?: IpVersion }): ZodString
Parameters
- Optionaloptions: string | { message?: string; version?: IpVersion }
Returns ZodString
- Defined in node_modules/zod/v3/types.d.cts:228

isNullable

isNullable(): boolean
Returns boolean
Inherited from ZodType.isNullable
- Defined in node_modules/zod/v3/types.d.cts:100

isOptional

isOptional(): boolean
Returns boolean
Inherited from ZodType.isOptional
- Defined in node_modules/zod/v3/types.d.cts:99

jwt

jwt(options?: { alg?: string; message?: string }): ZodString
Parameters
- Optionaloptions: { alg?: string; message?: string }
Returns ZodString
- Defined in node_modules/zod/v3/types.d.cts:224

length

length(len: number, message?: ErrMessage): ZodString
Parameters
- len: number
- Optionalmessage: ErrMessage
Returns ZodString
- Defined in node_modules/zod/v3/types.d.cts:257

max

max(maxLength: number, message?: ErrMessage): ZodString
Parameters
- maxLength: number
- Optionalmessage: ErrMessage
Returns ZodString
- Defined in node_modules/zod/v3/types.d.cts:256

min

min(minLength: number, message?: ErrMessage): ZodString
Parameters
- minLength: number
- Optionalmessage: ErrMessage
Returns ZodString
- Defined in node_modules/zod/v3/types.d.cts:255

nanoid

nanoid(message?: ErrMessage): ZodString
Parameters
- Optionalmessage: ErrMessage
Returns ZodString
- Defined in node_modules/zod/v3/types.d.cts:218

nonempty

nonempty(message?: ErrMessage): ZodString
Equivalent to .min(1)
Parameters
- Optionalmessage: ErrMessage
Returns ZodString
- Defined in node_modules/zod/v3/types.d.cts:261

nullable

nullable(): ZodNullable<ZodString>
Returns ZodNullable<ZodString>
Inherited from ZodType.nullable
- Defined in node_modules/zod/v3/types.d.cts:81

nullish

nullish(): ZodOptional<ZodNullable<ZodString>>
Returns ZodOptional<ZodNullable<ZodString>>
Inherited from ZodType.nullish
- Defined in node_modules/zod/v3/types.d.cts:82

optional

optional(): ZodOptional<ZodString>
Returns ZodOptional<ZodString>
Inherited from ZodType.optional
- Defined in node_modules/zod/v3/types.d.cts:80

or

or<T extends ZodTypeAny>(option: T): ZodUnion<[ZodString, T]>
Type Parameters
- T extends ZodTypeAny
Parameters
- option: T
Returns ZodUnion<[ZodString, T]>
Inherited from ZodType.or
- Defined in node_modules/zod/v3/types.d.cts:85

parse

parse(data: unknown, params?: InexactPartial<ParseParams>): string
Parameters
- data: unknown
- Optionalparams: InexactPartial<ParseParams>
Returns string
Inherited from ZodType.parse
- Defined in node_modules/zod/v3/types.d.cts:64

parseAsync

parseAsync(data: unknown, params?: InexactPartial<ParseParams>): Promise<string>
Parameters
- data: unknown
- Optionalparams: InexactPartial<ParseParams>
Returns Promise<string>
Inherited from ZodType.parseAsync
- Defined in node_modules/zod/v3/types.d.cts:67

pipe

pipe<T extends ZodTypeAny>(target: T): ZodPipeline<ZodString, T>
Type Parameters
- T extends ZodTypeAny
Parameters
- target: T
Returns ZodPipeline<ZodString, T>
Inherited from ZodType.pipe
- Defined in node_modules/zod/v3/types.d.cts:97

promise

promise(): ZodPromise<ZodString>
Returns ZodPromise<ZodString>
Inherited from ZodType.promise
- Defined in node_modules/zod/v3/types.d.cts:84

readonly

readonly(): ZodReadonly<ZodString>
Returns ZodReadonly<ZodString>
Inherited from ZodType.readonly
- Defined in node_modules/zod/v3/types.d.cts:98

refine

refine<RefinedOutput extends string>(
    check: (arg: string) => arg is RefinedOutput,
    message?:
        | string
        | Partial<Omit<ZodCustomIssue, "code">>
        | ((arg: string) => CustomErrorParams),
): ZodEffects<ZodString, RefinedOutput, string>
Type Parameters
- RefinedOutput extends string
Parameters
- check: (arg: string) => arg is RefinedOutput
- Optionalmessage:
      | string
      | Partial<Omit<ZodCustomIssue, "code">>
      | ((arg: string) => CustomErrorParams)
Returns ZodEffects<ZodString, RefinedOutput, string>
Inherited from ZodType.refine
- Defined in node_modules/zod/v3/types.d.cts:71
refine(
    check: (arg: string) => unknown,
    message?:
        | string
        | Partial<Omit<ZodCustomIssue, "code">>
        | ((arg: string) => CustomErrorParams),
): ZodEffects<ZodString, string, string>
Parameters
- check: (arg: string) => unknown
- Optionalmessage:
      | string
      | Partial<Omit<ZodCustomIssue, "code">>
      | ((arg: string) => CustomErrorParams)
Returns ZodEffects<ZodString, string, string>
Inherited from ZodType.refine
- Defined in node_modules/zod/v3/types.d.cts:72

refinement<RefinedOutput extends string>(
    check: (arg: string) => arg is RefinedOutput,
    refinementData:
        | IssueData
        | ((arg: string, ctx: RefinementCtx) => IssueData),
): 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>
Inherited from ZodType.refinement
- Defined in node_modules/zod/v3/types.d.cts:73
refinement(
    check: (arg: string) => boolean,
    refinementData:
        | IssueData
        | ((arg: string, ctx: RefinementCtx) => IssueData),
): ZodEffects<ZodString, string, string>
Parameters
- check: (arg: string) => boolean
- refinementData: IssueData | ((arg: string, ctx: RefinementCtx) => IssueData)
Returns ZodEffects<ZodString, string, string>
Inherited from ZodType.refinement
- Defined in node_modules/zod/v3/types.d.cts:74

regex

regex(regex: RegExp, message?: ErrMessage): ZodString
Parameters
- regex: RegExp
- Optionalmessage: ErrMessage
Returns ZodString
- Defined in node_modules/zod/v3/types.d.cts:248

safeParse

safeParse(
data: unknown,
params?: InexactPartial<ParseParams>,
): SafeParseReturnType<string, string>
Parameters
- data: unknown
- Optionalparams: InexactPartial<ParseParams>
Returns SafeParseReturnType<string, string>
Inherited from ZodType.safeParse
- Defined in node_modules/zod/v3/types.d.cts:65

safeParseAsync

safeParseAsync(
data: unknown,
params?: InexactPartial<ParseParams>,
): Promise<SafeParseReturnType<string, string>>
Parameters
- data: unknown
- Optionalparams: InexactPartial<ParseParams>
Returns Promise<SafeParseReturnType<string, string>>
Inherited from ZodType.safeParseAsync
- Defined in node_modules/zod/v3/types.d.cts:68

startsWith

startsWith(value: string, message?: ErrMessage): ZodString
Parameters
- value: string
- Optionalmessage: ErrMessage
Returns ZodString
- Defined in node_modules/zod/v3/types.d.cts:253

superRefine

superRefine<RefinedOutput extends string>(
refinement: (arg: string, ctx: RefinementCtx) => arg is RefinedOutput,
): ZodEffects<ZodString, RefinedOutput, string>
Type Parameters
- RefinedOutput extends string
Parameters
- refinement: (arg: string, ctx: RefinementCtx) => arg is RefinedOutput
Returns ZodEffects<ZodString, RefinedOutput, string>
Inherited from ZodType.superRefine
- Defined in node_modules/zod/v3/types.d.cts:76
superRefine(
refinement: (arg: string, ctx: RefinementCtx) => void,
): ZodEffects<ZodString, string, string>
Parameters
- refinement: (arg: string, ctx: RefinementCtx) => void
Returns ZodEffects<ZodString, string, string>
Inherited from ZodType.superRefine
- Defined in node_modules/zod/v3/types.d.cts:77
superRefine(
refinement: (arg: string, ctx: RefinementCtx) => Promise<void>,
): ZodEffects<ZodString, string, string>
Parameters
- refinement: (arg: string, ctx: RefinementCtx) => Promise<void>
Returns ZodEffects<ZodString, string, string>
Inherited from ZodType.superRefine
- Defined in node_modules/zod/v3/types.d.cts:78

time

time(
options?: string | { message?: string; precision?: number | null },
): ZodString
Parameters
- Optionaloptions: string | { message?: string; precision?: number | null }
Returns ZodString
- Defined in node_modules/zod/v3/types.d.cts:243

toLowerCase

toLowerCase(): ZodString
Returns ZodString
- Defined in node_modules/zod/v3/types.d.cts:263

toUpperCase

toUpperCase(): ZodString
Returns ZodString
- Defined in node_modules/zod/v3/types.d.cts:264

transform

transform<NewOut>(
transform: (arg: string, ctx: RefinementCtx) => NewOut | Promise<NewOut>,
): ZodEffects<ZodString, NewOut>
Type Parameters
- NewOut
Parameters
- transform: (arg: string, ctx: RefinementCtx) => NewOut | Promise<NewOut>
Returns ZodEffects<ZodString, NewOut>
Inherited from ZodType.transform
- Defined in node_modules/zod/v3/types.d.cts:87

trim

trim(): ZodString
Returns ZodString
- Defined in node_modules/zod/v3/types.d.cts:262

ulid

ulid(message?: ErrMessage): ZodString
Parameters
- Optionalmessage: ErrMessage
Returns ZodString
- Defined in node_modules/zod/v3/types.d.cts:221

url

url(message?: ErrMessage): ZodString
Parameters
- Optionalmessage: ErrMessage
Returns ZodString
- Defined in node_modules/zod/v3/types.d.cts:215

uuid

uuid(message?: ErrMessage): ZodString
Parameters
- Optionalmessage: ErrMessage
Returns ZodString
- Defined in node_modules/zod/v3/types.d.cts:217

Class ZodString

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ZodString

Properties

Readonly_def

Readonly_input

Readonly_output

Readonly_type

~standard

spa

Staticcreate

Accessors

description

Returns string | undefined

isBase64

Returns boolean

isBase64url

Returns boolean

isCIDR

Returns boolean

isCUID

Returns boolean

isCUID2

Returns boolean

isDate

Returns boolean

isDatetime

Returns boolean

isDuration

Returns boolean

isEmail

Returns boolean

isEmoji

Returns boolean

isIP

Returns boolean

isNANOID

Returns boolean

isTime

Returns boolean

isULID

Returns boolean

isURL

Returns boolean

isUUID

Returns boolean

maxLength

Returns number | null

minLength

Returns number | null

Methods

_addCheck

Parameters

Returns ZodString

_getOrReturnCtx

Parameters

Returns ParseContext

_getType

Parameters

Returns string

_parse

Parameters

Returns ParseReturnType<string>

_parseAsync

Parameters

Returns AsyncParseReturnType<string>

_parseSync

Parameters

Returns SyncParseReturnType<string>

_processInputParams

Parameters

Returns { ctx: ParseContext; status: ParseStatus }

`Readonly`_def

`Readonly`_input

`Readonly`_output

`Readonly`_type

`Static`create

`Protected`_regex