Class ZodString

Hierarchy

ZodType<string, ZodStringDef>
- ZodString

Index

Constructors

constructor

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

Properties

`Readonly` _def

_def: ZodStringDef

`Readonly` _input

_input: string

`Readonly` _output

_output: string

`Protected` _regex

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

Type declaration

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

`Readonly` _type

_type: string

nonempty

nonempty: ((message?: ErrMessage) => ZodString)

Type declaration

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

spa

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

Type declaration

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

trim

trim: (() => ZodString)

Type declaration

- (): ZodString
- Returns ZodString

`Static` create

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

Type declaration

- (params?: {
      description?: string;
      errorMap?: ZodErrorMap;
      invalid_type_error?: string;
      required_error?: string;
  } & {
      coerce?: true;
  }): 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:170

isDatetime

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

isEmail

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

isURL

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

isUUID

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

maxLength

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

minLength

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

Methods

_addCheck

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

_getOrReturnCtx

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

_parse

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

_parseAsync

_parseAsync(input: ParseInput): 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: ParseInput): 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: ParseInput): {
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: ((arg: string, ctx: RefinementCtx) => any)): ZodEffects<ZodString, string, string>
Parameters
- refinement: ((arg: string, ctx: RefinementCtx) => any)
  - - (arg: string, ctx: RefinementCtx): 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: T): ZodIntersection<ZodString, T>
Type Parameters
- T extends ZodType<any, any, any, T>
Parameters
- incoming: T
Returns ZodIntersection<ZodString, T>
Inherited from ZodType.and
- Defined in node_modules/zod/lib/types.d.ts:79

array

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

brand

brand<B>(brand?: B): 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:83

catch

catch(def: string): ZodCatch<ZodString>
Parameters
- def: string
Returns ZodCatch<ZodString>
Inherited from ZodType.catch
- Defined in node_modules/zod/lib/types.d.ts:84
catch(def: (() => string)): ZodCatch<ZodString>
Parameters
- def: (() => string)
  - - (): string
    - Returns string
Returns ZodCatch<ZodString>
Inherited from ZodType.catch
- Defined in node_modules/zod/lib/types.d.ts:85

cuid

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

datetime

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

default

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

describe

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

email

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

endsWith

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

isNullable

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

isOptional

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

length

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

max

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

min

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

nullable

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

nullish

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

optional

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

or

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

parse

parse(data: unknown, params?: Partial<ParseParams>): 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: unknown, params?: Partial<ParseParams>): 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: T): ZodPipeline<ZodString, T>
Type Parameters
- T extends ZodType<any, any, any, T>
Parameters
- target: T
Returns ZodPipeline<ZodString, T>
Inherited from ZodType.pipe
- Defined in node_modules/zod/lib/types.d.ts:87

promise

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

refine

refine<RefinedOutput>(check: ((arg: string) => arg is RefinedOutput), message?: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg: string) => Partial<Omit<ZodCustomIssue, "code">>)): ZodEffects<ZodString, RefinedOutput, string>
Type Parameters
- RefinedOutput extends string
Parameters
- check: ((arg: string) => arg is RefinedOutput)
  - - (arg: string): arg is RefinedOutput
    - Parameters
      
      arg: string
      
      Returns arg is RefinedOutput
- Optional message: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg: string) => 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: ((arg: string) => unknown), message?: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg: string) => Partial<Omit<ZodCustomIssue, "code">>)): ZodEffects<ZodString, string, string>
Parameters
- check: ((arg: string) => unknown)
  - - (arg: string): unknown
    - Parameters
      
      arg: string
      
      Returns unknown
- Optional message: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg: string) => 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: ((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)
  - - (arg: string): arg is RefinedOutput
    - Parameters
      
      arg: string
      
      Returns arg is RefinedOutput
- refinementData: IssueData | ((arg: string, ctx: RefinementCtx) => IssueData)
Returns ZodEffects<ZodString, RefinedOutput, string>
Inherited from ZodType.refinement
- Defined in node_modules/zod/lib/types.d.ts:67
refinement(check: ((arg: string) => boolean), refinementData: IssueData | ((arg: string, ctx: RefinementCtx) => IssueData)): ZodEffects<ZodString, string, string>
Parameters
- check: ((arg: string) => boolean)
  - - (arg: string): boolean
    - Parameters
      
      arg: string
      
      Returns boolean
- refinementData: IssueData | ((arg: string, ctx: RefinementCtx) => IssueData)
Returns ZodEffects<ZodString, string, string>
Inherited from ZodType.refinement
- Defined in node_modules/zod/lib/types.d.ts:68

regex

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

safeParse

safeParse(data: unknown, params?: Partial<ParseParams>): 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: unknown, params?: Partial<ParseParams>): 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: string, message?: ErrMessage): ZodString
Parameters
- value: string
- Optional message: ErrMessage
Returns ZodString
- Defined in node_modules/zod/lib/types.d.ts:155

superRefine

superRefine<RefinedOutput>(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)
  - - (arg: string, ctx: RefinementCtx): 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: ((arg: string, ctx: RefinementCtx) => void)): ZodEffects<ZodString, string, string>
Parameters
- refinement: ((arg: string, ctx: RefinementCtx) => void)
  - - (arg: string, ctx: RefinementCtx): 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

transform

transform<NewOut>(transform: ((arg: string, ctx: RefinementCtx) => NewOut | Promise<NewOut>)): ZodEffects<ZodString, NewOut, string>
Type Parameters
- NewOut
Parameters
- transform: ((arg: string, ctx: RefinementCtx) => NewOut | Promise<NewOut>)
  - - (arg: string, ctx: RefinementCtx): 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:80

url

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

uuid

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

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

Deprecated

See

Parameters

Optional message: ErrMessage

Returns ZodString

spa

Type declaration

Parameters

data: unknown

Optional params: Partial<ParseParams>

Returns Promise<SafeParseReturnType<string, string>>

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

isDatetime

Returns boolean

isEmail

Returns boolean

isURL

Returns boolean

isUUID

Returns boolean

maxLength

Returns null | number

minLength

Returns null | number

Methods

_addCheck

Parameters

check: ZodStringCheck

Returns ZodString

_getOrReturnCtx

Parameters

input: ParseInput

Optional ctx: ParseContext

Returns ParseContext

_getType

Parameters

input: ParseInput

Returns string

_parse

Parameters

input: ParseInput

Returns ParseReturnType<string>

`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

`Optional` message: ErrMessage

`Optional` options: string | {
message?: string;
offset?: boolean;
precision?: null | number;
}

`Optional` message: ErrMessage