Class ZodString

Hierarchy (view full)

ZodType<string, ZodStringDef>
- ZodString

Constructors

constructor

new ZodString(def): ZodString
Parameters
- def: ZodStringDef
Returns ZodString
Inherited from ZodType.constructor
- Defined in node_modules/zod/lib/types.d.ts:73

Properties

`Readonly` _def

_def: ZodStringDef

`Readonly` _input

_input: string

`Readonly` _output

_output: string

`Readonly` _type

_type: string

spa

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

Alias of safeParseAsync

Type declaration

- (data, params?): Promise<SafeParseReturnType<string, string>>
- Parameters
  - data: unknown
  - Optional params: Partial<ParseParams>
  Returns Promise<SafeParseReturnType<string, string>>

`Static` create

create: ((params?) => ZodString)

Type declaration

- (params?): ZodString
- Parameters
  - Optional params: {
        description?: string;
        errorMap?: ZodErrorMap;
        invalid_type_error?: string;
        required_error?: string;
    } & {
        coerce?: true;
    }
  Returns ZodString

Accessors

description

get description(): undefined | string
Returns undefined | string
Inherited from ZodType.description
- Defined in node_modules/zod/lib/types.d.ts:49

isCUID

get isCUID(): boolean
Returns boolean
- Defined in node_modules/zod/lib/types.d.ts:214

isCUID2

get isCUID2(): boolean
Returns boolean
- Defined in node_modules/zod/lib/types.d.ts:215

isDatetime

get isDatetime(): boolean
Returns boolean
- Defined in node_modules/zod/lib/types.d.ts:209

isEmail

get isEmail(): boolean
Returns boolean
- Defined in node_modules/zod/lib/types.d.ts:210

isEmoji

get isEmoji(): boolean
Returns boolean
- Defined in node_modules/zod/lib/types.d.ts:212

isIP

get isIP(): boolean
Returns boolean
- Defined in node_modules/zod/lib/types.d.ts:217

isULID

get isULID(): boolean
Returns boolean
- Defined in node_modules/zod/lib/types.d.ts:216

isURL

get isURL(): boolean
Returns boolean
- Defined in node_modules/zod/lib/types.d.ts:211

isUUID

get isUUID(): boolean
Returns boolean
- Defined in node_modules/zod/lib/types.d.ts:213

maxLength

get maxLength(): null | number
Returns null | number
- Defined in node_modules/zod/lib/types.d.ts:219

minLength

get minLength(): null | number
Returns null | number
- Defined in node_modules/zod/lib/types.d.ts:218

Methods

_addCheck

_addCheck(check): ZodString
Parameters
- check: ZodStringCheck
Returns ZodString
- Defined in node_modules/zod/lib/types.d.ts:174

_getOrReturnCtx

_getOrReturnCtx(input, ctx?): ParseContext
Parameters
- input: ParseInput
- Optional ctx: ParseContext
Returns ParseContext
Inherited from ZodType._getOrReturnCtx
- Defined in node_modules/zod/lib/types.d.ts:52

_getType

_getType(input): string
Parameters
- input: ParseInput
Returns string
Inherited from ZodType._getType
- Defined in node_modules/zod/lib/types.d.ts:51

_parse

_parse(input): ParseReturnType<string>
Parameters
- input: ParseInput
Returns ParseReturnType<string>
Overrides ZodType._parse
- Defined in node_modules/zod/lib/types.d.ts:172

_parseAsync

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

_parseSync

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

_processInputParams

_processInputParams(input): {
ctx: ParseContext;
status: ParseStatus;
}
Parameters
- input: ParseInput
Returns {
ctx: ParseContext;
status: ParseStatus;
}
- ctx: ParseContext
- status: ParseStatus
Inherited from ZodType._processInputParams
- Defined in node_modules/zod/lib/types.d.ts:53

_refinement

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

and

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

array

array(): ZodArray<ZodString, "many">
Returns ZodArray<ZodString, "many">
Inherited from ZodType.array
- Defined in node_modules/zod/lib/types.d.ts:77

brand

brand<B>(brand?): ZodBranded<ZodString, B>
Type Parameters
- B extends string | number | symbol
Parameters
- Optional brand: B
Returns ZodBranded<ZodString, B>
Inherited from ZodType.brand
- Defined in node_modules/zod/lib/types.d.ts:84

catch

catch(def): ZodCatch<ZodString>
Parameters
- def: string
Returns ZodCatch<ZodString>
Inherited from ZodType.catch
- Defined in node_modules/zod/lib/types.d.ts:85
catch(def): ZodCatch<ZodString>
Parameters
- def: ((ctx) => string)
  - - (ctx): string
    - Parameters
      ctx: {
      error: ZodError<any>;
      input: string;
      }
      error: ZodError<any>
      input: string
      Returns string
Returns ZodCatch<ZodString>
Inherited from ZodType.catch
- Defined in node_modules/zod/lib/types.d.ts:86

cuid

cuid(message?): ZodString
Parameters
- Optional message: ErrMessage
Returns ZodString
- Defined in node_modules/zod/lib/types.d.ts:179

cuid2

cuid2(message?): ZodString
Parameters
- Optional message: ErrMessage
Returns ZodString
- Defined in node_modules/zod/lib/types.d.ts:180

datetime

datetime(options?): ZodString
Parameters
- Optional options: string | {
      message?: string;
      offset?: boolean;
      precision?: null | number;
  }
Returns ZodString
- Defined in node_modules/zod/lib/types.d.ts:186

default

default(def): ZodDefault<ZodString>
Parameters
- def: string
Returns ZodDefault<ZodString>
Inherited from ZodType.default
- Defined in node_modules/zod/lib/types.d.ts:82
default(def): ZodDefault<ZodString>
Parameters
- def: (() => string)
  - - (): string
    - Returns string
Returns ZodDefault<ZodString>
Inherited from ZodType.default
- Defined in node_modules/zod/lib/types.d.ts:83

describe

describe(description): this
Parameters
- description: string
Returns this
Inherited from ZodType.describe
- Defined in node_modules/zod/lib/types.d.ts:90

email

email(message?): ZodString
Parameters
- Optional message: ErrMessage
Returns ZodString
- Defined in node_modules/zod/lib/types.d.ts:175

emoji

emoji(message?): ZodString
Parameters
- Optional message: ErrMessage
Returns ZodString
- Defined in node_modules/zod/lib/types.d.ts:177

endsWith

endsWith(value, message?): ZodString
Parameters
- value: string
- Optional message: ErrMessage
Returns ZodString
- Defined in node_modules/zod/lib/types.d.ts:197

includes

includes(value, options?): ZodString
Parameters
- value: string
- Optional options: {
  message?: string;
  position?: number;
  }
  - Optional message?: string
  - Optional position?: number
Returns ZodString
- Defined in node_modules/zod/lib/types.d.ts:192

ip

ip(options?): ZodString
Parameters
- Optional options: string | {
  message?: string;
  version?: "v4" | "v6";
  }
Returns ZodString
- Defined in node_modules/zod/lib/types.d.ts:182

isNullable

isNullable(): boolean
Returns boolean
Inherited from ZodType.isNullable
- Defined in node_modules/zod/lib/types.d.ts:94

isOptional

isOptional(): boolean
Returns boolean
Inherited from ZodType.isOptional
- Defined in node_modules/zod/lib/types.d.ts:93

length

length(len, message?): ZodString
Parameters
- len: number
- Optional message: ErrMessage
Returns ZodString
- Defined in node_modules/zod/lib/types.d.ts:200

max

max(maxLength, message?): ZodString
Parameters
- maxLength: number
- Optional message: ErrMessage
Returns ZodString
- Defined in node_modules/zod/lib/types.d.ts:199

min

min(minLength, message?): ZodString
Parameters
- minLength: number
- Optional message: ErrMessage
Returns ZodString
- Defined in node_modules/zod/lib/types.d.ts:198

nonempty

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

See
ZodString.min
- Defined in node_modules/zod/lib/types.d.ts:205

nullable

nullable(): ZodNullable<ZodString>
Returns ZodNullable<ZodString>
Inherited from ZodType.nullable
- Defined in node_modules/zod/lib/types.d.ts:75

nullish

nullish(): ZodOptional<ZodNullable<ZodString>>
Returns ZodOptional<ZodNullable<ZodString>>
Inherited from ZodType.nullish
- Defined in node_modules/zod/lib/types.d.ts:76

optional

optional(): ZodOptional<ZodString>
Returns ZodOptional<ZodString>
Inherited from ZodType.optional
- Defined in node_modules/zod/lib/types.d.ts:74

or

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

parse

parse(data, params?): string
Parameters
- data: unknown
- Optional params: Partial<ParseParams>
Returns string
Inherited from ZodType.parse
- Defined in node_modules/zod/lib/types.d.ts:59

parseAsync

parseAsync(data, params?): Promise<string>
Parameters
- data: unknown
- Optional params: Partial<ParseParams>
Returns Promise<string>
Inherited from ZodType.parseAsync
- Defined in node_modules/zod/lib/types.d.ts:61

pipe

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

promise

promise(): ZodPromise<ZodString>
Returns ZodPromise<ZodString>
Inherited from ZodType.promise
- Defined in node_modules/zod/lib/types.d.ts:78

readonly

readonly(): ZodReadonly<ZodString>
Returns ZodReadonly<ZodString>
Inherited from ZodType.readonly
- Defined in node_modules/zod/lib/types.d.ts:92

refine

refine<RefinedOutput>(check, message?): ZodEffects<ZodString, RefinedOutput, string>
Type Parameters
- RefinedOutput extends string
Parameters
- check: ((arg) => arg is RefinedOutput)
  - - (arg): arg is RefinedOutput
    - Parameters
      arg: string
      Returns arg is RefinedOutput
- Optional message: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg) => Partial<Omit<ZodCustomIssue, "code">>)
Returns ZodEffects<ZodString, RefinedOutput, string>
Inherited from ZodType.refine
- Defined in node_modules/zod/lib/types.d.ts:65
refine(check, message?): ZodEffects<ZodString, string, string>
Parameters
- check: ((arg) => unknown)
  - - (arg): unknown
    - Parameters
      arg: string
      Returns unknown
- Optional message: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg) => Partial<Omit<ZodCustomIssue, "code">>)
Returns ZodEffects<ZodString, string, string>
Inherited from ZodType.refine
- Defined in node_modules/zod/lib/types.d.ts:66

refinement

refinement<RefinedOutput>(check, refinementData): ZodEffects<ZodString, RefinedOutput, string>
Type Parameters
- RefinedOutput extends string
Parameters
- check: ((arg) => arg is RefinedOutput)
  - - (arg): arg is RefinedOutput
    - Parameters
      arg: string
      Returns arg is RefinedOutput
- refinementData: IssueData | ((arg, ctx) => IssueData)
Returns ZodEffects<ZodString, RefinedOutput, string>
Inherited from ZodType.refinement
- Defined in node_modules/zod/lib/types.d.ts:67
refinement(check, refinementData): ZodEffects<ZodString, string, string>
Parameters
- check: ((arg) => boolean)
  - - (arg): boolean
    - Parameters
      arg: string
      Returns boolean
- refinementData: IssueData | ((arg, ctx) => IssueData)
Returns ZodEffects<ZodString, string, string>
Inherited from ZodType.refinement
- Defined in node_modules/zod/lib/types.d.ts:68

regex

regex(regex, message?): ZodString
Parameters
- regex: RegExp
- Optional message: ErrMessage
Returns ZodString
- Defined in node_modules/zod/lib/types.d.ts:191

safeParse

safeParse(data, params?): SafeParseReturnType<string, string>
Parameters
- data: unknown
- Optional params: Partial<ParseParams>
Returns SafeParseReturnType<string, string>
Inherited from ZodType.safeParse
- Defined in node_modules/zod/lib/types.d.ts:60

safeParseAsync

safeParseAsync(data, params?): Promise<SafeParseReturnType<string, string>>
Parameters
- data: unknown
- Optional params: Partial<ParseParams>
Returns Promise<SafeParseReturnType<string, string>>
Inherited from ZodType.safeParseAsync
- Defined in node_modules/zod/lib/types.d.ts:62

startsWith

startsWith(value, message?): ZodString
Parameters
- value: string
- Optional message: ErrMessage
Returns ZodString
- Defined in node_modules/zod/lib/types.d.ts:196

superRefine

superRefine<RefinedOutput>(refinement): ZodEffects<ZodString, RefinedOutput, string>
Type Parameters
- RefinedOutput extends string
Parameters
- refinement: ((arg, ctx) => arg is RefinedOutput)
  - - (arg, ctx): arg is RefinedOutput
    - Parameters
      arg: string
      ctx: RefinementCtx
      Returns arg is RefinedOutput
Returns ZodEffects<ZodString, RefinedOutput, string>
Inherited from ZodType.superRefine
- Defined in node_modules/zod/lib/types.d.ts:70
superRefine(refinement): ZodEffects<ZodString, string, string>
Parameters
- refinement: ((arg, ctx) => void)
  - - (arg, ctx): void
    - Parameters
      arg: string
      ctx: RefinementCtx
      Returns void
Returns ZodEffects<ZodString, string, string>
Inherited from ZodType.superRefine
- Defined in node_modules/zod/lib/types.d.ts:71
superRefine(refinement): ZodEffects<ZodString, string, string>
Parameters
- refinement: ((arg, ctx) => Promise<void>)
  - - (arg, ctx): Promise<void>
    - Parameters
      arg: string
      ctx: RefinementCtx
      Returns Promise<void>
Returns ZodEffects<ZodString, string, string>
Inherited from ZodType.superRefine
- Defined in node_modules/zod/lib/types.d.ts:72

toLowerCase

toLowerCase(): ZodString
Returns ZodString
- Defined in node_modules/zod/lib/types.d.ts:207

toUpperCase

toUpperCase(): ZodString
Returns ZodString
- Defined in node_modules/zod/lib/types.d.ts:208

transform

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

trim

trim(): ZodString
Returns ZodString
- Defined in node_modules/zod/lib/types.d.ts:206

ulid

ulid(message?): ZodString
Parameters
- Optional message: ErrMessage
Returns ZodString
- Defined in node_modules/zod/lib/types.d.ts:181

url

url(message?): ZodString
Parameters
- Optional message: ErrMessage
Returns ZodString
- Defined in node_modules/zod/lib/types.d.ts:176

uuid

uuid(message?): ZodString
Parameters
- Optional message: ErrMessage
Returns ZodString
- Defined in node_modules/zod/lib/types.d.ts:178

Class ZodString

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ZodString

Properties

Readonly _def

Readonly _input

Readonly _output

Readonly _type

spa

Type declaration

Parameters

Returns Promise<SafeParseReturnType<string, string>>

Static create

Type declaration

Parameters

Returns ZodString

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 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; }

ctx: ParseContext

status: ParseStatus

_refinement

Parameters

Parameters

Returns any

Returns ZodEffects<ZodString, string, string>

and

Type Parameters

`Readonly` _def

`Readonly` _input

`Readonly` _output

`Readonly` _type

`Static` create

Returns {
ctx: ParseContext;
status: ParseStatus;
}

`Optional` message?: string

`Optional` position?: number