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`_type

_type: string

`Readonly`_output

_output: string

`Readonly`_input

_input: string

`Readonly`_def

_def: ZodStringDef

~standard

"~standard": Props<string, string>

spa

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

Alias of safeParseAsync

`Static`create

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

Accessors

description

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

isDatetime

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

isDate

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

isTime

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

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

isURL

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

isEmoji

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

isUUID

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

isNANOID

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

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

isULID

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

isIP

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

isCIDR

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

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

minLength

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

maxLength

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

Methods

_getType

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

_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

_processInputParams

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

_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

_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

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

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

~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

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

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

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

_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

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

optional

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

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

array

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

promise

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

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

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

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

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

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

describe

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

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

readonly

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

isOptional

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

isNullable

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

_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

`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

_addCheck

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

email

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

url

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

emoji

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

uuid

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

nanoid

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

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

ulid

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

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

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

ip

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

cidr

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

datetime

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

date

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

time

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

duration

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

regex

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

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

startsWith

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

endsWith

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

min

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

max

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

length

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

nonempty

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

trim

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

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

Class ZodString

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ZodString

Properties

Readonly_type

Readonly_output

Readonly_input

Readonly_def

~standard

spa

Staticcreate

Accessors

description

Returns undefined | string

isDatetime

Returns boolean

isDate

Returns boolean

isTime

Returns boolean

isDuration

Returns boolean

isEmail

Returns boolean

isURL

Returns boolean

isEmoji

Returns boolean

isUUID

Returns boolean

isNANOID

Returns boolean

isCUID

Returns boolean

isCUID2

Returns boolean

isULID

Returns boolean

isIP

Returns boolean

isCIDR

Returns boolean

isBase64

Returns boolean

isBase64url

Returns boolean

minLength

Returns null | number

maxLength

Returns null | number

Methods

_getType

Parameters

Returns string

_getOrReturnCtx

Parameters

Returns ParseContext

_processInputParams

Parameters

Returns { status: ParseStatus; ctx: ParseContext }

_parseSync

Parameters

Returns SyncParseReturnType<string>

_parseAsync

Parameters

Returns AsyncParseReturnType<string>

parse

Parameters

Returns string

safeParse

Parameters

Returns SafeParseReturnType<string, string>

`Readonly`_type

`Readonly`_output

`Readonly`_input

`Readonly`_def

`Static`create