Class ZodOptional<T>

Type Parameters

T extends ZodTypeAny

Hierarchy

ZodType<T["_output"] | undefined, ZodOptionalDef<T>, T["_input"] | undefined>
- ZodOptional

Index

Constructors

constructor

new ZodOptional<T>(def: ZodOptionalDef<T>): ZodOptional<T>
Type Parameters
- T extends ZodType<any, any, any, T>
Parameters
- def: ZodOptionalDef<T>
Returns ZodOptional<T>
Inherited from ZodType.constructor
- Defined in node_modules/zod/lib/types.d.ts:72

Properties

`Readonly` _def

_def: ZodOptionalDef<T>

`Readonly` _input

_input: undefined | T["_input"]

`Readonly` _output

_output: undefined | T["_output"]

`Readonly` _type

_type: undefined | T["_output"]

spa

spa: ((data: unknown, params?: Partial<ParseParams>) => Promise<SafeParseReturnType<undefined | T["_input"], undefined | T["_output"]>>)

Type declaration

- (data: unknown, params?: Partial<ParseParams>): Promise<SafeParseReturnType<undefined | T["_input"], undefined | T["_output"]>>
- Alias of safeParseAsync
  Parameters
  - data: unknown
  - Optional params: Partial<ParseParams>
  Returns Promise<SafeParseReturnType<undefined | T["_input"], undefined | T["_output"]>>

`Static` create

create: (<T_1>(type: T_1, params?: RawCreateParams) => ZodOptional<T_1>)

Type declaration

- <T_1>(type: T_1, params?: RawCreateParams): ZodOptional<T_1>
- Type Parameters
  - T_1 extends ZodType<any, any, any, T_1>
  Parameters
  - type: T_1
  - Optional params: RawCreateParams
  Returns ZodOptional<T_1>

Accessors

description

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

Methods

_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<undefined | T["_output"]>
Parameters
- input: ParseInput
Returns ParseReturnType<undefined | T["_output"]>
Overrides ZodType._parse
- Defined in node_modules/zod/lib/types.d.ts:719

_parseAsync

_parseAsync(input: ParseInput): AsyncParseReturnType<undefined | T["_output"]>
Parameters
- input: ParseInput
Returns AsyncParseReturnType<undefined | T["_output"]>
Inherited from ZodType._parseAsync
- Defined in node_modules/zod/lib/types.d.ts:58

_parseSync

_parseSync(input: ParseInput): SyncParseReturnType<undefined | T["_output"]>
Parameters
- input: ParseInput
Returns SyncParseReturnType<undefined | T["_output"]>
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: undefined | T["_output"], ctx: RefinementCtx) => any)): ZodEffects<ZodOptional<T>, undefined | T["_output"], undefined | T["_input"]>
Parameters
- refinement: ((arg: undefined | T["_output"], ctx: RefinementCtx) => any)
  - - (arg: undefined | T["_output"], ctx: RefinementCtx): any
    - Parameters
      
      arg: undefined | T["_output"]
      
      ctx: RefinementCtx
      
      Returns any
Returns ZodEffects<ZodOptional<T>, undefined | T["_output"], undefined | T["_input"]>
Inherited from ZodType._refinement
- Defined in node_modules/zod/lib/types.d.ts:69

and

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

array

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

brand

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

catch

catch(def: undefined | T["_input"]): ZodCatch<ZodOptional<T>>
Parameters
- def: undefined | T["_input"]
Returns ZodCatch<ZodOptional<T>>
Inherited from ZodType.catch
- Defined in node_modules/zod/lib/types.d.ts:84
catch(def: (() => undefined | T["_input"])): ZodCatch<ZodOptional<T>>
Parameters
- def: (() => undefined | T["_input"])
  - - (): undefined | T["_input"]
    - Returns undefined | T["_input"]
Returns ZodCatch<ZodOptional<T>>
Inherited from ZodType.catch
- Defined in node_modules/zod/lib/types.d.ts:85

default

default(def: noUndefined<T["_input"]>): ZodDefault<ZodOptional<T>>
Parameters
- def: noUndefined<T["_input"]>
Returns ZodDefault<ZodOptional<T>>
Inherited from ZodType.default
- Defined in node_modules/zod/lib/types.d.ts:81
default(def: (() => noUndefined<T["_input"]>)): ZodDefault<ZodOptional<T>>
Parameters
- def: (() => noUndefined<T["_input"]>)
  - - (): noUndefined<T["_input"]>
    - Returns noUndefined<T["_input"]>
Returns ZodDefault<ZodOptional<T>>
Inherited from ZodType.default
- Defined in node_modules/zod/lib/types.d.ts:82

describe

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

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

nullable

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

nullish

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

optional

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

or

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

parse

parse(data: unknown, params?: Partial<ParseParams>): undefined | T["_output"]
Parameters
- data: unknown
- Optional params: Partial<ParseParams>
Returns undefined | T["_output"]
Inherited from ZodType.parse
- Defined in node_modules/zod/lib/types.d.ts:59

parseAsync

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

pipe

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

promise

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

refine

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

refinement

refinement<RefinedOutput>(check: ((arg: undefined | T["_output"]) => arg is RefinedOutput), refinementData: IssueData | ((arg: undefined | T["_output"], ctx: RefinementCtx) => IssueData)): ZodEffects<ZodOptional<T>, RefinedOutput, undefined | T["_input"]>
Type Parameters
- RefinedOutput extends any
Parameters
- check: ((arg: undefined | T["_output"]) => arg is RefinedOutput)
  - - (arg: undefined | T["_output"]): arg is RefinedOutput
    - Parameters
      
      arg: undefined | T["_output"]
      
      Returns arg is RefinedOutput
- refinementData: IssueData | ((arg: undefined | T["_output"], ctx: RefinementCtx) => IssueData)
Returns ZodEffects<ZodOptional<T>, RefinedOutput, undefined | T["_input"]>
Inherited from ZodType.refinement
- Defined in node_modules/zod/lib/types.d.ts:67
refinement(check: ((arg: undefined | T["_output"]) => boolean), refinementData: IssueData | ((arg: undefined | T["_output"], ctx: RefinementCtx) => IssueData)): ZodEffects<ZodOptional<T>, undefined | T["_output"], undefined | T["_input"]>
Parameters
- check: ((arg: undefined | T["_output"]) => boolean)
  - - (arg: undefined | T["_output"]): boolean
    - Parameters
      
      arg: undefined | T["_output"]
      
      Returns boolean
- refinementData: IssueData | ((arg: undefined | T["_output"], ctx: RefinementCtx) => IssueData)
Returns ZodEffects<ZodOptional<T>, undefined | T["_output"], undefined | T["_input"]>
Inherited from ZodType.refinement
- Defined in node_modules/zod/lib/types.d.ts:68

safeParse

safeParse(data: unknown, params?: Partial<ParseParams>): SafeParseReturnType<undefined | T["_input"], undefined | T["_output"]>
Parameters
- data: unknown
- Optional params: Partial<ParseParams>
Returns SafeParseReturnType<undefined | T["_input"], undefined | T["_output"]>
Inherited from ZodType.safeParse
- Defined in node_modules/zod/lib/types.d.ts:60

safeParseAsync

safeParseAsync(data: unknown, params?: Partial<ParseParams>): Promise<SafeParseReturnType<undefined | T["_input"], undefined | T["_output"]>>
Parameters
- data: unknown
- Optional params: Partial<ParseParams>
Returns Promise<SafeParseReturnType<undefined | T["_input"], undefined | T["_output"]>>
Inherited from ZodType.safeParseAsync
- Defined in node_modules/zod/lib/types.d.ts:62

superRefine

superRefine<RefinedOutput>(refinement: ((arg: undefined | T["_output"], ctx: RefinementCtx) => arg is RefinedOutput)): ZodEffects<ZodOptional<T>, RefinedOutput, undefined | T["_input"]>
Type Parameters
- RefinedOutput extends any
Parameters
- refinement: ((arg: undefined | T["_output"], ctx: RefinementCtx) => arg is RefinedOutput)
  - - (arg: undefined | T["_output"], ctx: RefinementCtx): arg is RefinedOutput
    - Parameters
      
      arg: undefined | T["_output"]
      
      ctx: RefinementCtx
      
      Returns arg is RefinedOutput
Returns ZodEffects<ZodOptional<T>, RefinedOutput, undefined | T["_input"]>
Inherited from ZodType.superRefine
- Defined in node_modules/zod/lib/types.d.ts:70
superRefine(refinement: ((arg: undefined | T["_output"], ctx: RefinementCtx) => void)): ZodEffects<ZodOptional<T>, undefined | T["_output"], undefined | T["_input"]>
Parameters
- refinement: ((arg: undefined | T["_output"], ctx: RefinementCtx) => void)
  - - (arg: undefined | T["_output"], ctx: RefinementCtx): void
    - Parameters
      
      arg: undefined | T["_output"]
      
      ctx: RefinementCtx
      
      Returns void
Returns ZodEffects<ZodOptional<T>, undefined | T["_output"], undefined | T["_input"]>
Inherited from ZodType.superRefine
- Defined in node_modules/zod/lib/types.d.ts:71

transform

transform<NewOut>(transform: ((arg: undefined | T["_output"], ctx: RefinementCtx) => NewOut | Promise<NewOut>)): ZodEffects<ZodOptional<T>, NewOut, undefined | T["_input"]>
Type Parameters
- NewOut
Parameters
- transform: ((arg: undefined | T["_output"], ctx: RefinementCtx) => NewOut | Promise<NewOut>)
  - - (arg: undefined | T["_output"], ctx: RefinementCtx): NewOut | Promise<NewOut>
    - Parameters
      
      arg: undefined | T["_output"]
      
      ctx: RefinementCtx
      
      Returns NewOut | Promise<NewOut>
Returns ZodEffects<ZodOptional<T>, NewOut, undefined | T["_input"]>
Inherited from ZodType.transform
- Defined in node_modules/zod/lib/types.d.ts:80

unwrap

unwrap(): T
Returns T
- Defined in node_modules/zod/lib/types.d.ts:720

Class ZodOptional<T>

Type Parameters

T extends ZodTypeAny

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T extends ZodType<any, any, any, T>

Parameters

def: ZodOptionalDef<T>

Returns ZodOptional<T>

Properties

Readonly _def

Readonly _input

Readonly _output

Readonly _type

spa

Type declaration

Parameters

data: unknown

Optional params: Partial<ParseParams>

Returns Promise<SafeParseReturnType<undefined | T["_input"], undefined | T["_output"]>>

Static create

Type declaration

Type Parameters

T_1 extends ZodType<any, any, any, T_1>

Parameters

type: T_1

Optional params: RawCreateParams

Returns ZodOptional<T_1>

Accessors

description

Returns undefined | string

Methods

_getOrReturnCtx

Parameters

input: ParseInput

Optional ctx: ParseContext

Returns ParseContext

_getType

Parameters

input: ParseInput

Returns string

_parse

Parameters

input: ParseInput

Returns ParseReturnType<undefined | T["_output"]>

_parseAsync

Parameters

input: ParseInput

Returns AsyncParseReturnType<undefined | T["_output"]>

_parseSync

Parameters

input: ParseInput

Returns SyncParseReturnType<undefined | T["_output"]>

_processInputParams

Parameters

input: ParseInput

Returns { ctx: ParseContext; status: ParseStatus; }

ctx: ParseContext

status: ParseStatus

_refinement

Parameters

refinement: ((arg: undefined | T["_output"], ctx: RefinementCtx) => any)

Parameters

arg: undefined | T["_output"]

ctx: RefinementCtx

Returns any

Returns ZodEffects<ZodOptional<T>, undefined | T["_output"], undefined | T["_input"]>

and

Type Parameters

T extends ZodType<any, any, any, T>

Parameters

incoming: T

Returns ZodIntersection<ZodOptional<T>, T>

`Readonly` _def

`Readonly` _input

`Readonly` _output

`Readonly` _type

`Optional` params: Partial<ParseParams>

`Static` create

`Optional` params: RawCreateParams

`Optional` ctx: ParseContext

Returns {
ctx: ParseContext;
status: ParseStatus;
}

`Optional` brand: B

`Optional` params: Partial<ParseParams>

`Optional` params: Partial<ParseParams>