Class ZodString

Hierarchy

ZodType<string, ZodStringDef>
Hierarchy
- ZodString

Index

Constructors

constructor

new ZodString(def: ZodStringDef): ZodString
Parameters
- def: ZodStringDef
Returns ZodString
Inherited from ZodType.constructor
- Defined in repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:67

Properties

`Readonly` _def

_def: ZodStringDef

`Readonly` _input

_input: string

`Readonly` _output

_output: string

`Protected` _regex

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

Type declaration

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

`Readonly` _type

_type: string

nonempty

nonempty: ((message?: string | { message?: string }) => ZodString)

Type declaration

- (message?: string | { message?: string }): ZodString
- Deprecated
  Use z.string().min(1) instead.
  
  See
  min
  Parameters
  - Optional message: string | { message?: string }
  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>>

superRefine

superRefine: ((refinement: ((arg: string, ctx: RefinementCtx) => any)) => ZodEffects<ZodString, string, string>)

Type declaration

- (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>

trim

trim: (() => ZodString)

Type declaration

- (): ZodString
- Returns ZodString

`Static` create

create: ((params?: RawCreateParams) => ZodString)

Type declaration

- (params?: RawCreateParams): ZodString
- Parameters
  - Optional params: RawCreateParams
  Returns ZodString

Accessors

description

get description(): undefined | string
Returns undefined | string
Inherited from ZodType.description
- Defined in repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:45

isCUID

get isCUID(): boolean
Returns boolean
- Defined in repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:150

isEmail

get isEmail(): boolean
Returns boolean
- Defined in repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:147

isURL

get isURL(): boolean
Returns boolean
- Defined in repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:148

isUUID

get isUUID(): boolean
Returns boolean
- Defined in repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:149

maxLength

get maxLength(): null | number
Returns null | number
- Defined in repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:152

minLength

get minLength(): null | number
Returns null | number
- Defined in repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:151

Methods

_addCheck

_addCheck(check: ZodStringCheck): ZodString
Parameters
- check: ZodStringCheck
Returns ZodString
- Defined in repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:128

_getOrReturnCtx

_getOrReturnCtx(input: ParseInput, ctx?: ParseContext): ParseContext
Parameters
- input: ParseInput
- Optional ctx: ParseContext
Returns ParseContext
Inherited from ZodType._getOrReturnCtx
- Defined in repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:48

_getType

_getType(input: ParseInput): string
Parameters
- input: ParseInput
Returns string
Inherited from ZodType._getType
- Defined in repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:47

_parse

_parse(input: ParseInput): ParseReturnType<string>
Parameters
- input: ParseInput
Returns ParseReturnType<string>
Overrides ZodType._parse
- Defined in repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:124

_parseAsync

_parseAsync(input: ParseInput): AsyncParseReturnType<string>
Parameters
- input: ParseInput
Returns AsyncParseReturnType<string>
Inherited from ZodType._parseAsync
- Defined in repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:54

_parseSync

_parseSync(input: ParseInput): SyncParseReturnType<string>
Parameters
- input: ParseInput
Returns SyncParseReturnType<string>
Inherited from ZodType._parseSync
- Defined in repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:53

_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 repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:49

_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 repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:65

and

and<T>(incoming: T): ZodIntersection<ZodString, T>
Type Parameters
Type Parameters
- T extends ZodType<any, any, any, T>
Parameters
- incoming: T
Returns ZodIntersection<ZodString, T>
Inherited from ZodType.and
- Defined in repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:74

array

array(): ZodArray<ZodString, "many">
Returns ZodArray<ZodString, "many">
Inherited from ZodType.array
- Defined in repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:71

brand

brand<B>(): ZodBranded<ZodString, B>
Type Parameters
Type Parameters
- B extends string | number | symbol
Returns ZodBranded<ZodString, B>
Inherited from ZodType.brand
- Defined in repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:78

cuid

cuid(message?: ErrMessage): ZodString
Parameters
- Optional message: ErrMessage
Returns ZodString
- Defined in repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:132

default

default(def: string): ZodDefault<ZodString>
Parameters
- def: string
Returns ZodDefault<ZodString>
Inherited from ZodType.default
- Defined in repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:76
default(def: (() => string)): ZodDefault<ZodString>
Parameters
- def: (() => string)
  - - (): string
    - Returns string
Returns ZodDefault<ZodString>
Inherited from ZodType.default
- Defined in repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:77

describe

describe(description: string): ZodString
Parameters
- description: string
Returns ZodString
Inherited from ZodType.describe
- Defined in repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:79

email

email(message?: ErrMessage): ZodString
Parameters
- Optional message: ErrMessage
Returns ZodString
- Defined in repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:129

endsWith

endsWith(value: string, message?: ErrMessage): ZodString
Parameters
- value: string
- Optional message: ErrMessage
Returns ZodString
- Defined in repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:135

isNullable

isNullable(): boolean
Returns boolean
Inherited from ZodType.isNullable
- Defined in repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:81

isOptional

isOptional(): boolean
Returns boolean
Inherited from ZodType.isOptional
- Defined in repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:80

length

length(len: number, message?: ErrMessage): ZodString
Parameters
- len: number
- Optional message: ErrMessage
Returns ZodString
- Defined in repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:138

max

max(maxLength: number, message?: ErrMessage): ZodString
Parameters
- maxLength: number
- Optional message: ErrMessage
Returns ZodString
- Defined in repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:137

min

min(minLength: number, message?: ErrMessage): ZodString
Parameters
- minLength: number
- Optional message: ErrMessage
Returns ZodString
- Defined in repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:136

nullable

nullable(): ZodNullable<ZodString>
Returns ZodNullable<ZodString>
Inherited from ZodType.nullable
- Defined in repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:69

nullish

nullish(): ZodNullable<ZodOptional<ZodString>>
Returns ZodNullable<ZodOptional<ZodString>>
Inherited from ZodType.nullish
- Defined in repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:70

optional

optional(): ZodOptional<ZodString>
Returns ZodOptional<ZodString>
Inherited from ZodType.optional
- Defined in repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:68

or

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

parse

parse(data: unknown, params?: Partial<ParseParams>): string
Parameters
- data: unknown
- Optional params: Partial<ParseParams>
Returns string
Inherited from ZodType.parse
- Defined in repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:55

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 repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:57

promise

promise(): ZodPromise<ZodString>
Returns ZodPromise<ZodString>
Inherited from ZodType.promise
- Defined in repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:72

refine

refine<RefinedOutput>(check: ((arg: string) => arg is RefinedOutput), message?: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg: string) => Partial<Omit<ZodCustomIssue, "code">>)): ZodEffects<ZodString, RefinedOutput, RefinedOutput>
Type Parameters
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, RefinedOutput>
Inherited from ZodType.refine
- Defined in repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:61
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 repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:62

refinement

refinement<RefinedOutput>(check: ((arg: string) => arg is RefinedOutput), refinementData: IssueData | ((arg: string, ctx: RefinementCtx) => IssueData)): ZodEffects<ZodString, RefinedOutput, RefinedOutput>
Type Parameters
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, RefinedOutput>
Inherited from ZodType.refinement
- Defined in repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:63
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 repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:64

regex

regex(regex: RegExp, message?: ErrMessage): ZodString
Parameters
- regex: RegExp
- Optional message: ErrMessage
Returns ZodString
- Defined in repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:133

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 repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:56

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 repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:58

startsWith

startsWith(value: string, message?: ErrMessage): ZodString
Parameters
- value: string
- Optional message: ErrMessage
Returns ZodString
- Defined in repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:134

transform

transform<NewOut>(transform: ((arg: string, ctx: RefinementCtx) => NewOut | Promise<NewOut>)): ZodEffects<ZodString, NewOut, string>
Type Parameters
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 repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:75

url

url(message?: ErrMessage): ZodString
Parameters
- Optional message: ErrMessage
Returns ZodString
- Defined in repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:130

uuid

uuid(message?: ErrMessage): ZodString
Parameters
- Optional message: ErrMessage
Returns ZodString
- Defined in repos/sidestream/test-lerna/sidebase-mono/node_modules/zod/lib/types.d.ts:131

Class ZodString

Hierarchy

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: string | { message?: string }

Returns ZodEffects<ZodString, string, string>

Readonly _type

nonempty

Type declaration

Deprecated

See

Parameters

Optional message: string | { message?: string }

Returns ZodString

spa

Type declaration

Parameters

data: unknown

Optional params: Partial<ParseParams>

Returns Promise<SafeParseReturnType<string, string>>

superRefine

Type declaration

Parameters

refinement: ((arg: string, ctx: RefinementCtx) => any)

Parameters

arg: string

ctx: RefinementCtx

Returns any

Returns ZodEffects<ZodString, string, string>

trim

Type declaration

Returns ZodString

Static create

Type declaration

Parameters

Optional params: RawCreateParams

Returns ZodString

Accessors

description

Returns undefined | string

isCUID

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

`Readonly` _def

`Readonly` _input

`Readonly` _output

`Protected` _regex

`Optional` message: string | { message?: string }

`Readonly` _type

`Optional` message: string | { message?: string }

`Optional` params: Partial<ParseParams>

`Static` create

`Optional` params: RawCreateParams

`Optional` ctx: ParseContext

`Optional` message: ErrMessage

`Optional` message: ErrMessage

`Optional` message: ErrMessage