Class ZodNullable<T>

Type Parameters

T extends ZodTypeAny

Hierarchy (view full)

ZodType<T["_output"] | null, ZodNullableDef<T>, T["_input"] | null>
- ZodNullable

Index

Constructors

constructor

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

Properties

`Readonly` _def

_def: ZodNullableDef<T>

`Readonly` _input

_input: null | T["_input"]

`Readonly` _output

_output: null | T["_output"]

`Readonly` _type

_type: null | T["_output"]

spa

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

Alias of safeParseAsync

Type declaration

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

`Static` create

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

Type declaration

- <T_1>(type, params?): ZodNullable<T_1>
- Type Parameters
  - T_1 extends ZodTypeAny
  Parameters
  - type: T_1
  - Optional params: RawCreateParams
  Returns ZodNullable<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, ctx?): 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): string
Parameters
- input: ParseInput
Returns string
Inherited from ZodType._getType
- Defined in node_modules/zod/lib/types.d.ts:51

_parse

_parse(input): ParseReturnType<null | T["_output"]>
Parameters
- input: ParseInput
Returns ParseReturnType<null | T["_output"]>
Overrides ZodType._parse
- Defined in node_modules/zod/lib/types.d.ts:808

_parseAsync

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

_parseSync

_parseSync(input): SyncParseReturnType<null | T["_output"]>
Parameters
- input: ParseInput
Returns SyncParseReturnType<null | T["_output"]>
Inherited from ZodType._parseSync
- Defined in node_modules/zod/lib/types.d.ts:57

_processInputParams

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

and

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

array

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

brand

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

catch

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

default

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

describe

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

isNullable

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

isOptional

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

nullable

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

nullish

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

optional

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

or

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

parse

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

parseAsync

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

pipe

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

promise

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

readonly

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

refine

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

refinement

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

safeParse

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

safeParseAsync

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

superRefine

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

transform

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

unwrap

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

Class ZodNullable<T>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ZodNullable<T>

Properties

Readonly _def

Readonly _input

Readonly _output

Readonly _type

spa

Type declaration

Parameters

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

Static create

Type declaration

Type Parameters

Parameters

Returns ZodNullable<T_1>

Accessors

description

Returns undefined | string

Methods

_getOrReturnCtx

Parameters

Returns ParseContext

_getType

Parameters

Returns string

_parse

Parameters

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

_parseAsync

Parameters

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

_parseSync

Parameters

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

_processInputParams

Parameters

Returns { ctx: ParseContext; status: ParseStatus; }

ctx: ParseContext

status: ParseStatus

_refinement

Parameters

Parameters

Returns any

Returns ZodEffects<ZodNullable<T>, null | T["_output"], null | T["_input"]>

and

Type Parameters

Parameters

Returns ZodIntersection<ZodNullable<T>, T>

array

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

brand

Type Parameters

Parameters

Returns ZodBranded<ZodNullable<T>, B>

catch

Parameters

Returns ZodCatch<ZodNullable<T>>

Parameters

Parameters

error: ZodError<any>

input: null | T["_input"]

Returns null | T["_output"]

Returns ZodCatch<ZodNullable<T>>

default

Parameters

Returns ZodDefault<ZodNullable<T>>

Parameters

Returns null | noUndefined<T["_input"]>

`Readonly` _def

`Readonly` _input

`Readonly` _output

`Readonly` _type

`Static` create

Returns {
ctx: ParseContext;
status: ParseStatus;
}