Class ZodString

Hierarchy

ZodType<string, ZodStringDef>
- ZodString

Constructors

constructor

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

Properties

`Readonly` _def

_def: ZodStringDef

`Readonly` _input

_input: string

`Readonly` _output

_output: string

`Protected` _regex

_regex: ((regex, validation, message?) => ZodEffects<ZodString, string, string>)

Type declaration

- (regex, validation, message?): ZodEffects<ZodString, string, string>
- Parameters
  - regex: RegExp
  - validation: StringValidation
  - Optional message: ErrMessage
  Returns ZodEffects<ZodString, string, string>

`Readonly` _type

_type: string

nonempty

nonempty: ((message?) => ZodString)

Type declaration

- (message?): ZodString
- Parameters
  - Optional message: ErrMessage
  Returns ZodString

spa

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

Type declaration

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

toLowerCase

toLowerCase: (() => ZodString)

Type declaration

- (): ZodString
- Returns ZodString

toUpperCase

toUpperCase: (() => ZodString)

Type declaration

- (): ZodString
- Returns ZodString

trim

trim: (() => ZodString)

Type declaration

- (): ZodString
- Returns ZodString

`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/.pnpm/zod@3.21.4/node_modules/zod/lib/types.d.ts:49

isCUID

get isCUID(): boolean
Returns boolean
- Defined in node_modules/.pnpm/zod@3.21.4/node_modules/zod/lib/types.d.ts:207

isCUID2

get isCUID2(): boolean
Returns boolean
- Defined in node_modules/.pnpm/zod@3.21.4/node_modules/zod/lib/types.d.ts:208

isDatetime

get isDatetime(): boolean
Returns boolean
- Defined in node_modules/.pnpm/zod@3.21.4/node_modules/zod/lib/types.d.ts:202

isEmail

get isEmail(): boolean
Returns boolean
- Defined in node_modules/.pnpm/zod@3.21.4/node_modules/zod/lib/types.d.ts:203

isEmoji

get isEmoji(): boolean
Returns boolean
- Defined in node_modules/.pnpm/zod@3.21.4/node_modules/zod/lib/types.d.ts:205

isIP

get isIP(): boolean
Returns boolean
- Defined in node_modules/.pnpm/zod@3.21.4/node_modules/zod/lib/types.d.ts:210

isULID

get isULID(): boolean
Returns boolean
- Defined in node_modules/.pnpm/zod@3.21.4/node_modules/zod/lib/types.d.ts:209

isURL

get isURL(): boolean
Returns boolean
- Defined in node_modules/.pnpm/zod@3.21.4/node_modules/zod/lib/types.d.ts:204

isUUID

get isUUID(): boolean
Returns boolean
- Defined in node_modules/.pnpm/zod@3.21.4/node_modules/zod/lib/types.d.ts:206

maxLength

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

minLength

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

Methods

_addCheck

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

_getOrReturnCtx

_getOrReturnCtx(input, ctx?): ParseContext
Parameters
- input: ParseInput
- Optional ctx: ParseContext
Returns ParseContext
Inherited from ZodType._getOrReturnCtx
- Defined in node_modules/.pnpm/zod@3.21.4/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/.pnpm/zod@3.21.4/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/.pnpm/zod@3.21.4/node_modules/zod/lib/types.d.ts:169

_parseAsync

_parseAsync(input): AsyncParseReturnType<string>
Parameters
- input: ParseInput
Returns AsyncParseReturnType<string>
Inherited from ZodType._parseAsync
- Defined in node_modules/.pnpm/zod@3.21.4/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/.pnpm/zod@3.21.4/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/.pnpm/zod@3.21.4/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/.pnpm/zod@3.21.4/node_modules/zod/lib/types.d.ts:68

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/.pnpm/zod@3.21.4/node_modules/zod/lib/types.d.ts:78

array

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

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/.pnpm/zod@3.21.4/node_modules/zod/lib/types.d.ts:82

catch

catch(def): ZodCatch<ZodString>
Parameters
- def: string
Returns ZodCatch<ZodString>
Inherited from ZodType.catch
- Defined in node_modules/.pnpm/zod@3.21.4/node_modules/zod/lib/types.d.ts:83
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/.pnpm/zod@3.21.4/node_modules/zod/lib/types.d.ts:84

cuid

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

cuid2

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

datetime

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

default

default(def): ZodDefault<ZodString>
Parameters
- def: string
Returns ZodDefault<ZodString>
Inherited from ZodType.default
- Defined in node_modules/.pnpm/zod@3.21.4/node_modules/zod/lib/types.d.ts:80
default(def): ZodDefault<ZodString>
Parameters
- def: (() => string)
  - - (): string
    - Returns string
Returns ZodDefault<ZodString>
Inherited from ZodType.default
- Defined in node_modules/.pnpm/zod@3.21.4/node_modules/zod/lib/types.d.ts:81

describe

describe(description): ZodString
Parameters
- description: string
Returns ZodString
Inherited from ZodType.describe
- Defined in node_modules/.pnpm/zod@3.21.4/node_modules/zod/lib/types.d.ts:88

email

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

emoji

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

endsWith

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

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/.pnpm/zod@3.21.4/node_modules/zod/lib/types.d.ts:189

ip

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

isNullable

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

isOptional

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

length

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

max

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

min

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

nullable

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

nullish

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

optional

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

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/.pnpm/zod@3.21.4/node_modules/zod/lib/types.d.ts:77

parse

parse(data, params?): string
Parameters
- data: unknown
- Optional params: Partial<ParseParams>
Returns string
Inherited from ZodType.parse
- Defined in node_modules/.pnpm/zod@3.21.4/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/.pnpm/zod@3.21.4/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/.pnpm/zod@3.21.4/node_modules/zod/lib/types.d.ts:89

promise

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

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/.pnpm/zod@3.21.4/node_modules/zod/lib/types.d.ts:64
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/.pnpm/zod@3.21.4/node_modules/zod/lib/types.d.ts:65

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/.pnpm/zod@3.21.4/node_modules/zod/lib/types.d.ts:66
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/.pnpm/zod@3.21.4/node_modules/zod/lib/types.d.ts:67

regex

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

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/.pnpm/zod@3.21.4/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/.pnpm/zod@3.21.4/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/.pnpm/zod@3.21.4/node_modules/zod/lib/types.d.ts:193

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/.pnpm/zod@3.21.4/node_modules/zod/lib/types.d.ts:69
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/.pnpm/zod@3.21.4/node_modules/zod/lib/types.d.ts:70

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/.pnpm/zod@3.21.4/node_modules/zod/lib/types.d.ts:79

ulid

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

url

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

uuid

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

Class ZodString

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

def: ZodStringDef

Returns ZodString

Properties

Readonly _def

Readonly _input

Readonly _output

Protected _regex

Type declaration

Parameters

regex: RegExp

validation: StringValidation

Optional message: ErrMessage

Returns ZodEffects<ZodString, string, string>

Readonly _type

nonempty

Type declaration

Parameters

Optional message: ErrMessage

Returns ZodString

spa

Type declaration

Parameters

data: unknown

Optional params: Partial<ParseParams>

Returns Promise<SafeParseReturnType<string, string>>

toLowerCase

Type declaration

Returns ZodString

toUpperCase

Type declaration

Returns ZodString

trim

Type declaration

Returns ZodString

Static create

Type declaration

Parameters

Optional params: { description?: string; errorMap?: ZodErrorMap; invalid_type_error?: string; required_error?: string; } & { coerce?: true; }

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

check: ZodStringCheck

Returns ZodString

_getOrReturnCtx

`Readonly` _def

`Readonly` _input

`Readonly` _output

`Protected` _regex

`Optional` message: ErrMessage

`Readonly` _type

`Optional` message: ErrMessage

`Optional` params: Partial<ParseParams>

`Static` create

`Optional` params: {
description?: string;
errorMap?: ZodErrorMap;
invalid_type_error?: string;
required_error?: string;
} & {
coerce?: true;
}

`Optional` ctx: ParseContext

Returns {
ctx: ParseContext;
status: ParseStatus;
}

`Optional` brand: B

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

`Optional` message: ErrMessage

`Optional` message: ErrMessage