title: Core.z. Zod String

A2A Node SDK - v0.1.0 / Modules / Core / z / ZodString

Class: ZodString

Core.z.ZodString

Hierarchy

ZodType<string, ZodStringDef, string>

↳ ZodString

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

• new ZodString(def): ZodString

Parameters

Name	Type
`def`	`ZodStringDef`

Returns

ZodString

Inherited from

ZodType.constructor

Properties

_def

• Readonly _def: ZodStringDef

Inherited from

ZodType._def

_input

• Readonly _input: string

Inherited from

ZodType._input

_output

• Readonly _output: string

Inherited from

ZodType._output

_type

• Readonly _type: string

Inherited from

ZodType._type

create

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

Type declaration

▸ (params?): ZodString

Parameters

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

Returns

ZodString

spa

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

Alias of safeParseAsync

Type declaration

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

Parameters

Name	Type
`data`	`unknown`
`params?`	`InexactPartial`<`ParseParams`>

Returns

Promise<SafeParseReturnType<string, string>>

Inherited from

ZodType.spa

~standard

• ~standard: Props<string, string>

Inherited from

ZodType.~standard

Accessors

description

• get description(): undefined | string

Returns

undefined | string

Inherited from

ZodType.description

isBase64

• get isBase64(): boolean

Returns

boolean

isBase64url

• get isBase64url(): boolean

Returns

boolean

isCIDR

• get isCIDR(): boolean

Returns

boolean

isCUID

• get isCUID(): boolean

Returns

boolean

isCUID2

• get isCUID2(): boolean

Returns

boolean

isDate

• get isDate(): boolean

Returns

boolean

isDatetime

• get isDatetime(): boolean

Returns

boolean

isDuration

• get isDuration(): boolean

Returns

boolean

isEmail

• get isEmail(): boolean

Returns

boolean

isEmoji

• get isEmoji(): boolean

Returns

boolean

isIP

• get isIP(): boolean

Returns

boolean

isNANOID

• get isNANOID(): boolean

Returns

boolean

isTime

• get isTime(): boolean

Returns

boolean

isULID

• get isULID(): boolean

Returns

boolean

isURL

• get isURL(): boolean

Returns

boolean

isUUID

• get isUUID(): boolean

Returns

boolean

maxLength

• get maxLength(): null | number

Returns

null | number

minLength

• get minLength(): null | number

Returns

null | number

Methods

_addCheck

▸ _addCheck(check): ZodString

Parameters

Name	Type
`check`	`ZodStringCheck`

Returns

ZodString

_getOrReturnCtx

▸ _getOrReturnCtx(input, ctx?): ParseContext

Parameters

Name	Type
`input`	`ParseInput`
`ctx?`	`ParseContext`

Returns

ParseContext

Inherited from

ZodType._getOrReturnCtx

_getType

▸ _getType(input): string

Parameters

Name	Type
`input`	`ParseInput`

Returns

string

Inherited from

ZodType._getType

_parse

▸ _parse(input): ParseReturnType<string>

Parameters

Name	Type
`input`	`ParseInput`

Returns

ParseReturnType<string>

Overrides

ZodType._parse

_parseAsync

▸ _parseAsync(input): AsyncParseReturnType<string>

Parameters

Name	Type
`input`	`ParseInput`

Returns

AsyncParseReturnType<string>

Inherited from

ZodType._parseAsync

_parseSync

▸ _parseSync(input): SyncParseReturnType<string>

Parameters

Name	Type
`input`	`ParseInput`

Returns

SyncParseReturnType<string>

Inherited from

ZodType._parseSync

_processInputParams

▸ _processInputParams(input): Object

Parameters

Name	Type
`input`	`ParseInput`

Returns

Object

Name	Type
`ctx`	`ParseContext`
`status`	`ParseStatus`

Inherited from

ZodType._processInputParams

_refinement

▸ _refinement(refinement): ZodEffects<ZodString, string, string>

Parameters

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

Returns

ZodEffects<ZodString, string, string>

Inherited from

ZodType._refinement

_regex

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

Parameters

Name	Type
`regex`	`RegExp`
`validation`	`StringValidation`
`message?`	`ErrMessage`

Returns

ZodEffects<ZodString, string, string>

and

▸ and<T>(incoming): ZodIntersection<ZodString, T>

Type parameters

Name	Type
`T`	extends `ZodTypeAny`

Parameters

Name	Type
`incoming`	`T`

Returns

ZodIntersection<ZodString, T>

Inherited from

ZodType.and

array

▸ array(): ZodArray<ZodString, "many">

Returns

ZodArray<ZodString, "many">

Inherited from

ZodType.array

base64

▸ base64(message?): ZodString

Parameters

Name	Type
`message?`	`ErrMessage`

Returns

ZodString

base64url

▸ base64url(message?): ZodString

Parameters

Name	Type
`message?`	`ErrMessage`

Returns

ZodString

brand

▸ brand<B>(brand?): ZodBranded<ZodString, B>

Type parameters

Name	Type
`B`	extends `string` \| `number` \| `symbol`

Parameters

Name	Type
`brand?`	`B`

Returns

ZodBranded<ZodString, B>

Inherited from

ZodType.brand

catch

▸ catch(def): ZodCatch<ZodString>

Parameters

Name	Type
`def`	`string`

Returns

ZodCatch<ZodString>

Inherited from

ZodType.catch

▸ catch(def): ZodCatch<ZodString>

Parameters

Name	Type
`def`	(`ctx`: { `error`: `ZodError`<`any`> ; `input`: `string` }) => `string`

Returns

ZodCatch<ZodString>

Inherited from

ZodType.catch

cidr

▸ cidr(options?): ZodString

Parameters

Name	Type
`options?`	`string` \| { `message?`: `string` ; `version?`: `IpVersion` }

Returns

ZodString

cuid

▸ cuid(message?): ZodString

Parameters

Name	Type
`message?`	`ErrMessage`

Returns

ZodString

cuid2

▸ cuid2(message?): ZodString

Parameters

Name	Type
`message?`	`ErrMessage`

Returns

ZodString

date

▸ date(message?): ZodString

Parameters

Name	Type
`message?`	`string`

Returns

ZodString

datetime

▸ datetime(options?): ZodString

Parameters

Name	Type
`options?`	`string` \| { `local?`: `boolean` ; `message?`: `string` ; `offset?`: `boolean` ; `precision?`: `null` \| `number` }

Returns

ZodString

default

▸ default(def): ZodDefault<ZodString>

Parameters

Name	Type
`def`	`string`

Returns

ZodDefault<ZodString>

Inherited from

ZodType.default

▸ default(def): ZodDefault<ZodString>

Parameters

Name	Type
`def`	() => `string`

Returns

ZodDefault<ZodString>

Inherited from

ZodType.default

describe

▸ describe(description): this

Parameters

Name	Type
`description`	`string`

Returns

this

Inherited from

ZodType.describe

duration

▸ duration(message?): ZodString

Parameters

Name	Type
`message?`	`ErrMessage`

Returns

ZodString

email

▸ email(message?): ZodString

Parameters

Name	Type
`message?`	`ErrMessage`

Returns

ZodString

emoji

▸ emoji(message?): ZodString

Parameters

Name	Type
`message?`	`ErrMessage`

Returns

ZodString

endsWith

▸ endsWith(value, message?): ZodString

Parameters

Name	Type
`value`	`string`
`message?`	`ErrMessage`

Returns

ZodString

includes

▸ includes(value, options?): ZodString

Parameters

Name	Type
`value`	`string`
`options?`	`Object`
`options.message?`	`string`
`options.position?`	`number`

Returns

ZodString

ip

▸ ip(options?): ZodString

Parameters

Name	Type
`options?`	`string` \| { `message?`: `string` ; `version?`: `IpVersion` }

Returns

ZodString

isNullable

▸ isNullable(): boolean

Returns

boolean

Inherited from

ZodType.isNullable

isOptional

▸ isOptional(): boolean

Returns

boolean

Inherited from

ZodType.isOptional

jwt

▸ jwt(options?): ZodString

Parameters

Name	Type
`options?`	`Object`
`options.alg?`	`string`
`options.message?`	`string`

Returns

ZodString

length

▸ length(len, message?): ZodString

Parameters

Name	Type
`len`	`number`
`message?`	`ErrMessage`

Returns

ZodString

max

▸ max(maxLength, message?): ZodString

Parameters

Name	Type
`maxLength`	`number`
`message?`	`ErrMessage`

Returns

ZodString

min

▸ min(minLength, message?): ZodString

Parameters

Name	Type
`minLength`	`number`
`message?`	`ErrMessage`

Returns

ZodString

nanoid

▸ nanoid(message?): ZodString

Parameters

Name	Type
`message?`	`ErrMessage`

Returns

ZodString

nonempty

▸ nonempty(message?): ZodString

Equivalent to .min(1)

Parameters

Name	Type
`message?`	`ErrMessage`

or

▸ or<T>(option): ZodUnion<[ZodString, T]>

Type parameters

Name	Type
`T`	extends `ZodTypeAny`

Parameters

Name	Type
`option`	`T`

Returns

ZodUnion<[ZodString, T]>

Inherited from

ZodType.or

parse

▸ parse(data, params?): string

Parameters

Name	Type
`data`	`unknown`
`params?`	`InexactPartial`<`ParseParams`>

Returns

string

Inherited from

ZodType.parse

parseAsync

▸ parseAsync(data, params?): Promise<string>

Parameters

Name	Type
`data`	`unknown`
`params?`	`InexactPartial`<`ParseParams`>

Returns

Promise<string>

Inherited from

ZodType.parseAsync

pipe

▸ pipe<T>(target): ZodPipeline<ZodString, T>

Type parameters

Name	Type
`T`	extends `ZodTypeAny`

Parameters

Name	Type
`target`	`T`

Returns

ZodPipeline<ZodString, T>

Inherited from

ZodType.pipe

promise

▸ promise(): ZodPromise<ZodString>

Returns

ZodPromise<ZodString>

Inherited from

ZodType.promise

readonly

▸ readonly(): ZodReadonly<ZodString>

Returns

ZodReadonly<ZodString>

Inherited from

ZodType.readonly

refine

▸ refine<RefinedOutput>(check, message?): ZodEffects<ZodString, RefinedOutput, string>

Type parameters

Name	Type
`RefinedOutput`	extends `string`

Parameters

Name	Type
`check`	(`arg`: `string`) => arg is RefinedOutput
`message?`	`string` \| `Partial`<`Omit`<`ZodCustomIssue`, `"code"`>> \| (`arg`: `string`) => `Partial`<`Omit`<`ZodCustomIssue`, `"code"`>>

Returns

ZodEffects<ZodString, RefinedOutput, string>

Inherited from

ZodType.refine

▸ refine(check, message?): ZodEffects<ZodString, string, string>

Parameters

Name	Type
`check`	(`arg`: `string`) => `unknown`
`message?`	`string` \| `Partial`<`Omit`<`ZodCustomIssue`, `"code"`>> \| (`arg`: `string`) => `Partial`<`Omit`<`ZodCustomIssue`, `"code"`>>

Returns

ZodEffects<ZodString, string, string>

Inherited from

ZodType.refine

refinement

▸ refinement<RefinedOutput>(check, refinementData): ZodEffects<ZodString, RefinedOutput, string>

Type parameters

Name	Type
`RefinedOutput`	extends `string`

Parameters

Name	Type
`check`	(`arg`: `string`) => arg is RefinedOutput
`refinementData`	`IssueData` \| (`arg`: `string`, `ctx`: `RefinementCtx`) => `IssueData`

Returns

ZodEffects<ZodString, RefinedOutput, string>

Inherited from

ZodType.refinement

▸ refinement(check, refinementData): ZodEffects<ZodString, string, string>

Parameters

Name	Type
`check`	(`arg`: `string`) => `boolean`
`refinementData`	`IssueData` \| (`arg`: `string`, `ctx`: `RefinementCtx`) => `IssueData`

Returns

ZodEffects<ZodString, string, string>

Inherited from

ZodType.refinement

regex

▸ regex(regex, message?): ZodString

Parameters

Name	Type
`regex`	`RegExp`
`message?`	`ErrMessage`

Returns

ZodString

safeParse

▸ safeParse(data, params?): SafeParseReturnType<string, string>

Parameters

Name	Type
`data`	`unknown`
`params?`	`InexactPartial`<`ParseParams`>

Returns

SafeParseReturnType<string, string>

Inherited from

ZodType.safeParse

safeParseAsync

▸ safeParseAsync(data, params?): Promise<SafeParseReturnType<string, string>>

Parameters

Name	Type
`data`	`unknown`
`params?`	`InexactPartial`<`ParseParams`>

Returns

Promise<SafeParseReturnType<string, string>>

Inherited from

ZodType.safeParseAsync

startsWith

▸ startsWith(value, message?): ZodString

Parameters

Name	Type
`value`	`string`
`message?`	`ErrMessage`

Returns

ZodString

superRefine

▸ superRefine<RefinedOutput>(refinement): ZodEffects<ZodString, RefinedOutput, string>

Type parameters

Name	Type
`RefinedOutput`	extends `string`

Parameters

Name	Type
`refinement`	(`arg`: `string`, `ctx`: `RefinementCtx`) => arg is RefinedOutput

Returns

ZodEffects<ZodString, RefinedOutput, string>

Inherited from

ZodType.superRefine

▸ superRefine(refinement): ZodEffects<ZodString, string, string>

Parameters

Name	Type
`refinement`	(`arg`: `string`, `ctx`: `RefinementCtx`) => `void`

Returns

ZodEffects<ZodString, string, string>

Inherited from

ZodType.superRefine

▸ superRefine(refinement): ZodEffects<ZodString, string, string>

Parameters

Name	Type
`refinement`	(`arg`: `string`, `ctx`: `RefinementCtx`) => `Promise`<`void`>

Returns

ZodEffects<ZodString, string, string>

Inherited from

ZodType.superRefine

time

▸ time(options?): ZodString

Parameters

Name	Type
`options?`	`string` \| { `message?`: `string` ; `precision?`: `null` \| `number` }

Returns

ZodString

toLowerCase

▸ toLowerCase(): ZodString

Returns

ZodString

toUpperCase

▸ toUpperCase(): ZodString

Returns

ZodString

transform

▸ transform<NewOut>(transform): ZodEffects<ZodString, NewOut, string>

Type parameters

Name
`NewOut`

Parameters

Name	Type
`transform`	(`arg`: `string`, `ctx`: `RefinementCtx`) => `NewOut` \| `Promise`<`NewOut`>

Returns

ZodEffects<ZodString, NewOut, string>

Inherited from

ZodType.transform

trim

▸ trim(): ZodString

Returns

ZodString

ulid

▸ ulid(message?): ZodString

Parameters

Name	Type
`message?`	`ErrMessage`

Returns

ZodString

url

▸ url(message?): ZodString

Parameters

Name	Type
`message?`	`ErrMessage`

Returns

ZodString

uuid

▸ uuid(message?): ZodString

Parameters

Name	Type
`message?`	`ErrMessage`

Returns

ZodString

~validate

▸ ~validate(data): Result<string> | Promise<Result<string>>

Parameters

Name	Type
`data`	`unknown`

Returns

Result<string> | Promise<Result<string>>

Inherited from

ZodType.~validate

z.ZodSet z.ZodSymbol

title: Core.z. Zod String

Class: ZodString

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns

Inherited from

Properties

_def

Inherited from

_input

Inherited from

_output

Inherited from

_type

Inherited from

create

Type declaration

Parameters

Returns

spa

Type declaration

Parameters

Returns

Inherited from

~standard

Inherited from

Accessors

description

Returns

Inherited from

isBase64

Returns

isBase64url

Returns

isCIDR

Returns

isCUID

Returns

isCUID2

Returns

isDate

Returns

isDatetime

Returns

isDuration

Returns

isEmail

Returns

isEmoji

Returns

isIP

Returns

isNANOID

Returns

isTime

Returns

isULID

Returns

isURL

Returns

isUUID

Returns

maxLength

Returns

minLength

Returns

Methods

_addCheck

Parameters

Returns

_getOrReturnCtx

Parameters

Returns