Class ZodOptional<T>

Type Parameters

T extends ZodTypeAny

Hierarchy-Diagram

Legend

class

abstract class

public property

public method

underlined static property/method

italic abstract property/method

Hierarchy (view full)

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

Index

Constructors

constructor

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

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"]>>)

Alias of safeParseAsync

Type declaration

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

`Static` create

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

Type declaration

- <T_1 extends ZodTypeAny>(type: T_1, params?: RawCreateParams): ZodOptional<T_1>
- Type Parameters
  - T_1 extends ZodTypeAny
  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:52

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:55

_getType

_getType(input: ParseInput): string
Parameters
- input: ParseInput
Returns string
Inherited from ZodType._getType
- Defined in node_modules/zod/lib/types.d.ts:54

_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:844

_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:61

_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:60

_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:56

_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:72

and

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

array

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

brand

brand<B extends string | number | symbol>(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:87

catch

catch(def: undefined | T["_output"]): ZodCatch<ZodOptional<T>>
Parameters
- def: undefined | T["_output"]
Returns ZodCatch<ZodOptional<T>>
Inherited from ZodType.catch
- Defined in node_modules/zod/lib/types.d.ts:88
catch(def: ((ctx: {
error: ZodError<any>;
input: undefined | T["_input"];
}) => undefined | T["_output"])): ZodCatch<ZodOptional<T>>
Parameters
- def: ((ctx: {
  error: ZodError<any>;
  input: undefined | T["_input"];
  }) => undefined | T["_output"])
  - - (ctx: {
      error: ZodError<any>;
      input: undefined | T["_input"];
      }): undefined | T["_output"]
    - Parameters
      ctx: {
      error: ZodError<any>;
      input: undefined | T["_input"];
      }
      error: ZodError<any>
      input: undefined | T["_input"]
      Returns undefined | T["_output"]
Returns ZodCatch<ZodOptional<T>>
Inherited from ZodType.catch
- Defined in node_modules/zod/lib/types.d.ts:89

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:85
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:86

describe

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

isNullable

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

isOptional

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

nullable

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

nullish

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

optional

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

or

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

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:62

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:64

pipe

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

promise

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

readonly

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

refine

refine<RefinedOutput extends any>(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:68
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:69

refinement

refinement<RefinedOutput extends any>(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:70
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:71

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:63

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:65

superRefine

superRefine<RefinedOutput extends any>(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:73
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:74
superRefine(refinement: ((arg: undefined | T["_output"], ctx: RefinementCtx) => Promise<void>)): ZodEffects<ZodOptional<T>, undefined | T["_output"], undefined | T["_input"]>
Parameters
- refinement: ((arg: undefined | T["_output"], ctx: RefinementCtx) => Promise<void>)
  - - (arg: undefined | T["_output"], ctx: RefinementCtx): Promise<void>
    - Parameters
      arg: undefined | T["_output"]
      ctx: RefinementCtx
      Returns Promise<void>
Returns ZodEffects<ZodOptional<T>, undefined | T["_output"], undefined | T["_input"]>
Inherited from ZodType.superRefine
- Defined in node_modules/zod/lib/types.d.ts:75

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:84

unwrap

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

Class ZodOptional<T>

Type Parameters

Hierarchy-Diagram

Legend

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ZodOptional<T>

Properties

Readonly _def

Readonly _input

Readonly _output

Readonly _type

spa

Type declaration

Parameters

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

Static create

Type declaration

Type Parameters

Parameters

Returns ZodOptional<T_1>

Accessors

description

Returns undefined | string

Methods

_getOrReturnCtx

Parameters

Returns ParseContext

_getType

Parameters

Returns string

_parse

Parameters

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

_parseAsync

Parameters

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

_parseSync

Parameters

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

_processInputParams

Parameters

Returns { ctx: ParseContext; status: ParseStatus; }

ctx: ParseContext

status: ParseStatus

_refinement

Parameters

Parameters

Returns any

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

and

Type Parameters

Parameters

Returns ZodIntersection<ZodOptional<T>, T>

array

Returns ZodArray<ZodOptional<T>, "many">

brand

Type Parameters

Parameters

Returns ZodBranded<ZodOptional<T>, B>

catch

Parameters

Returns ZodCatch<ZodOptional<T>>

Parameters

Parameters

error: ZodError<any>

input: undefined | T["_input"]

Returns undefined | T["_output"]

Returns ZodCatch<ZodOptional<T>>

default

Parameters

Returns ZodDefault<ZodOptional<T>>

`Readonly` _def

`Readonly` _input

`Readonly` _output

`Readonly` _type

`Static` create

Returns {
ctx: ParseContext;
status: ParseStatus;
}