Class ZodDate

Hierarchy (View Summary)

ZodType<Date, ZodDateDef, Date>
- ZodDate

Index

Constructors

constructor

new ZodDate(def: ZodDateDef): ZodDate
Parameters
- def: ZodDateDef
Returns ZodDate
Inherited from ZodType.constructor
- Defined in node_modules/zod/v3/types.d.cts:79

Properties

`Readonly`_def

_def: ZodDateDef

`Readonly`_input

_input: Date

`Readonly`_output

_output: Date

`Readonly`_type

_type: Date

~standard

"~standard": Props<Date, Date>

spa

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

Alias of safeParseAsync

`Static`create

create: (
    params?: {
        description?: string;
        errorMap?: ZodErrorMap;
        invalid_type_error?: string;
        message?: string;
        required_error?: string;
    } & { coerce?: boolean },
) => ZodDate

Accessors

description

get description(): string | undefined
Returns string | undefined
Inherited from ZodType.description
- Defined in node_modules/zod/v3/types.d.cts:53

maxDate

get maxDate(): Date | null
Returns Date | null
- Defined in node_modules/zod/v3/types.d.cts:412

minDate

get minDate(): Date | null
Returns Date | null
- Defined in node_modules/zod/v3/types.d.cts:411

Methods

_addCheck

_addCheck(check: ZodDateCheck): ZodDate
Parameters
- check: ZodDateCheck
Returns ZodDate
- Defined in node_modules/zod/v3/types.d.cts:408

_getOrReturnCtx

_getOrReturnCtx(input: ParseInput, ctx?: ParseContext): ParseContext
Parameters
- input: ParseInput
- Optionalctx: ParseContext
Returns ParseContext
Inherited from ZodType._getOrReturnCtx
- Defined in node_modules/zod/v3/types.d.cts:57

_getType

_getType(input: ParseInput): string
Parameters
- input: ParseInput
Returns string
Inherited from ZodType._getType
- Defined in node_modules/zod/v3/types.d.cts:56

_parse

_parse(input: ParseInput): ParseReturnType<Date>
Parameters
- input: ParseInput
Returns ParseReturnType<Date>
Overrides ZodType._parse
- Defined in node_modules/zod/v3/types.d.cts:407

_parseAsync

_parseAsync(input: ParseInput): AsyncParseReturnType<Date>
Parameters
- input: ParseInput
Returns AsyncParseReturnType<Date>
Inherited from ZodType._parseAsync
- Defined in node_modules/zod/v3/types.d.cts:63

_parseSync

_parseSync(input: ParseInput): SyncParseReturnType<Date>
Parameters
- input: ParseInput
Returns SyncParseReturnType<Date>
Inherited from ZodType._parseSync
- Defined in node_modules/zod/v3/types.d.cts:62

_processInputParams

_processInputParams(
input: ParseInput,
): { ctx: ParseContext; status: ParseStatus }
Parameters
- input: ParseInput
Returns { ctx: ParseContext; status: ParseStatus }
Inherited from ZodType._processInputParams
- Defined in node_modules/zod/v3/types.d.cts:58

_refinement

_refinement(
refinement: (arg: Date, ctx: RefinementCtx) => any,
): ZodEffects<ZodDate, Date, Date>
Parameters
- refinement: (arg: Date, ctx: RefinementCtx) => any
Returns ZodEffects<ZodDate, Date, Date>
Inherited from ZodType._refinement
- Defined in node_modules/zod/v3/types.d.cts:75

~validate

"~validate"(data: unknown): Result<Date> | Promise<Result<Date>>
Parameters
- data: unknown
Returns Result<Date> | Promise<Result<Date>>
Inherited from ZodType.~validate
- Defined in node_modules/zod/v3/types.d.cts:66

and

and<T extends ZodTypeAny>(incoming: T): ZodIntersection<ZodDate, T>
Type Parameters
- T extends ZodTypeAny
Parameters
- incoming: T
Returns ZodIntersection<ZodDate, T>
Inherited from ZodType.and
- Defined in node_modules/zod/v3/types.d.cts:86

array

array(): ZodArray<ZodDate>
Returns ZodArray<ZodDate>
Inherited from ZodType.array
- Defined in node_modules/zod/v3/types.d.cts:83

brand

brand<B extends string | number | symbol>(brand?: B): ZodBranded<ZodDate, B>
Type Parameters
- B extends string | number | symbol
Parameters
- Optionalbrand: B
Returns ZodBranded<ZodDate, B>
Inherited from ZodType.brand
- Defined in node_modules/zod/v3/types.d.cts:90

catch

catch(def: Date): ZodCatch<ZodDate>
Parameters
- def: Date
Returns ZodCatch<ZodDate>
Inherited from ZodType.catch
- Defined in node_modules/zod/v3/types.d.cts:91
catch(def: (ctx: { error: ZodError; input: Date }) => Date): ZodCatch<ZodDate>
Parameters
- def: (ctx: { error: ZodError; input: Date }) => Date
Returns ZodCatch<ZodDate>
Inherited from ZodType.catch
- Defined in node_modules/zod/v3/types.d.cts:92

default

default(def: Date): ZodDefault<ZodDate>
Parameters
- def: Date
Returns ZodDefault<ZodDate>
Inherited from ZodType.default
- Defined in node_modules/zod/v3/types.d.cts:88
default(def: () => Date): ZodDefault<ZodDate>
Parameters
- def: () => Date
Returns ZodDefault<ZodDate>
Inherited from ZodType.default
- Defined in node_modules/zod/v3/types.d.cts:89

describe

describe(description: string): this
Parameters
- description: string
Returns this
Inherited from ZodType.describe
- Defined in node_modules/zod/v3/types.d.cts:96

isNullable

isNullable(): boolean
Returns boolean
Inherited from ZodType.isNullable
- Defined in node_modules/zod/v3/types.d.cts:100

isOptional

isOptional(): boolean
Returns boolean
Inherited from ZodType.isOptional
- Defined in node_modules/zod/v3/types.d.cts:99

max

max(maxDate: Date, message?: ErrMessage): ZodDate
Parameters
- maxDate: Date
- Optionalmessage: ErrMessage
Returns ZodDate
- Defined in node_modules/zod/v3/types.d.cts:410

min

min(minDate: Date, message?: ErrMessage): ZodDate
Parameters
- minDate: Date
- Optionalmessage: ErrMessage
Returns ZodDate
- Defined in node_modules/zod/v3/types.d.cts:409

nullable

nullable(): ZodNullable<ZodDate>
Returns ZodNullable<ZodDate>
Inherited from ZodType.nullable
- Defined in node_modules/zod/v3/types.d.cts:81

nullish

nullish(): ZodOptional<ZodNullable<ZodDate>>
Returns ZodOptional<ZodNullable<ZodDate>>
Inherited from ZodType.nullish
- Defined in node_modules/zod/v3/types.d.cts:82

optional

optional(): ZodOptional<ZodDate>
Returns ZodOptional<ZodDate>
Inherited from ZodType.optional
- Defined in node_modules/zod/v3/types.d.cts:80

or

or<T extends ZodTypeAny>(option: T): ZodUnion<[ZodDate, T]>
Type Parameters
- T extends ZodTypeAny
Parameters
- option: T
Returns ZodUnion<[ZodDate, T]>
Inherited from ZodType.or
- Defined in node_modules/zod/v3/types.d.cts:85

parse

parse(data: unknown, params?: InexactPartial<ParseParams>): Date
Parameters
- data: unknown
- Optionalparams: InexactPartial<ParseParams>
Returns Date
Inherited from ZodType.parse
- Defined in node_modules/zod/v3/types.d.cts:64

parseAsync

parseAsync(data: unknown, params?: InexactPartial<ParseParams>): Promise<Date>
Parameters
- data: unknown
- Optionalparams: InexactPartial<ParseParams>
Returns Promise<Date>
Inherited from ZodType.parseAsync
- Defined in node_modules/zod/v3/types.d.cts:67

pipe

pipe<T extends ZodTypeAny>(target: T): ZodPipeline<ZodDate, T>
Type Parameters
- T extends ZodTypeAny
Parameters
- target: T
Returns ZodPipeline<ZodDate, T>
Inherited from ZodType.pipe
- Defined in node_modules/zod/v3/types.d.cts:97

promise

promise(): ZodPromise<ZodDate>
Returns ZodPromise<ZodDate>
Inherited from ZodType.promise
- Defined in node_modules/zod/v3/types.d.cts:84

readonly

readonly(): ZodReadonly<ZodDate>
Returns ZodReadonly<ZodDate>
Inherited from ZodType.readonly
- Defined in node_modules/zod/v3/types.d.cts:98

refine

refine<RefinedOutput extends Date>(
    check: (arg: Date) => arg is RefinedOutput,
    message?:
        | string
        | Partial<Omit<ZodCustomIssue, "code">>
        | ((arg: Date) => CustomErrorParams),
): ZodEffects<ZodDate, RefinedOutput, Date>
Type Parameters
- RefinedOutput extends Date
Parameters
- check: (arg: Date) => arg is RefinedOutput
- Optionalmessage:
      | string
      | Partial<Omit<ZodCustomIssue, "code">>
      | ((arg: Date) => CustomErrorParams)
Returns ZodEffects<ZodDate, RefinedOutput, Date>
Inherited from ZodType.refine
- Defined in node_modules/zod/v3/types.d.cts:71
refine(
    check: (arg: Date) => unknown,
    message?:
        | string
        | Partial<Omit<ZodCustomIssue, "code">>
        | ((arg: Date) => CustomErrorParams),
): ZodEffects<ZodDate, Date, Date>
Parameters
- check: (arg: Date) => unknown
- Optionalmessage:
      | string
      | Partial<Omit<ZodCustomIssue, "code">>
      | ((arg: Date) => CustomErrorParams)
Returns ZodEffects<ZodDate, Date, Date>
Inherited from ZodType.refine
- Defined in node_modules/zod/v3/types.d.cts:72

refinement<RefinedOutput extends Date>(
check: (arg: Date) => arg is RefinedOutput,
refinementData: IssueData | ((arg: Date, ctx: RefinementCtx) => IssueData),
): ZodEffects<ZodDate, RefinedOutput, Date>
Type Parameters
- RefinedOutput extends Date
Parameters
- check: (arg: Date) => arg is RefinedOutput
- refinementData: IssueData | ((arg: Date, ctx: RefinementCtx) => IssueData)
Returns ZodEffects<ZodDate, RefinedOutput, Date>
Inherited from ZodType.refinement
- Defined in node_modules/zod/v3/types.d.cts:73
refinement(
check: (arg: Date) => boolean,
refinementData: IssueData | ((arg: Date, ctx: RefinementCtx) => IssueData),
): ZodEffects<ZodDate, Date, Date>
Parameters
- check: (arg: Date) => boolean
- refinementData: IssueData | ((arg: Date, ctx: RefinementCtx) => IssueData)
Returns ZodEffects<ZodDate, Date, Date>
Inherited from ZodType.refinement
- Defined in node_modules/zod/v3/types.d.cts:74

safeParse

safeParse(
data: unknown,
params?: InexactPartial<ParseParams>,
): SafeParseReturnType<Date, Date>
Parameters
- data: unknown
- Optionalparams: InexactPartial<ParseParams>
Returns SafeParseReturnType<Date, Date>
Inherited from ZodType.safeParse
- Defined in node_modules/zod/v3/types.d.cts:65

safeParseAsync

safeParseAsync(
data: unknown,
params?: InexactPartial<ParseParams>,
): Promise<SafeParseReturnType<Date, Date>>
Parameters
- data: unknown
- Optionalparams: InexactPartial<ParseParams>
Returns Promise<SafeParseReturnType<Date, Date>>
Inherited from ZodType.safeParseAsync
- Defined in node_modules/zod/v3/types.d.cts:68

superRefine

superRefine<RefinedOutput extends Date>(
refinement: (arg: Date, ctx: RefinementCtx) => arg is RefinedOutput,
): ZodEffects<ZodDate, RefinedOutput, Date>
Type Parameters
- RefinedOutput extends Date
Parameters
- refinement: (arg: Date, ctx: RefinementCtx) => arg is RefinedOutput
Returns ZodEffects<ZodDate, RefinedOutput, Date>
Inherited from ZodType.superRefine
- Defined in node_modules/zod/v3/types.d.cts:76
superRefine(
refinement: (arg: Date, ctx: RefinementCtx) => void,
): ZodEffects<ZodDate, Date, Date>
Parameters
- refinement: (arg: Date, ctx: RefinementCtx) => void
Returns ZodEffects<ZodDate, Date, Date>
Inherited from ZodType.superRefine
- Defined in node_modules/zod/v3/types.d.cts:77
superRefine(
refinement: (arg: Date, ctx: RefinementCtx) => Promise<void>,
): ZodEffects<ZodDate, Date, Date>
Parameters
- refinement: (arg: Date, ctx: RefinementCtx) => Promise<void>
Returns ZodEffects<ZodDate, Date, Date>
Inherited from ZodType.superRefine
- Defined in node_modules/zod/v3/types.d.cts:78

transform

transform<NewOut>(
transform: (arg: Date, ctx: RefinementCtx) => NewOut | Promise<NewOut>,
): ZodEffects<ZodDate, NewOut>
Type Parameters
- NewOut
Parameters
- transform: (arg: Date, ctx: RefinementCtx) => NewOut | Promise<NewOut>
Returns ZodEffects<ZodDate, NewOut>
Inherited from ZodType.transform
- Defined in node_modules/zod/v3/types.d.cts:87

Class ZodDate

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ZodDate

Properties

Readonly_def

Readonly_input

Readonly_output

Readonly_type

~standard

spa

Staticcreate

Accessors

description

Returns string | undefined

maxDate

Returns Date | null

minDate

Returns Date | null

Methods

_addCheck

Parameters

Returns ZodDate

_getOrReturnCtx

Parameters

Returns ParseContext

_getType

Parameters

Returns string

_parse

Parameters

Returns ParseReturnType<Date>

_parseAsync

Parameters

Returns AsyncParseReturnType<Date>

_parseSync

Parameters

Returns SyncParseReturnType<Date>

_processInputParams

Parameters

Returns { ctx: ParseContext; status: ParseStatus }

_refinement

Parameters

Returns ZodEffects<ZodDate, Date, Date>

~validate

Parameters

Returns Result<Date> | Promise<Result<Date>>

and

Type Parameters

Parameters

Returns ZodIntersection<ZodDate, T>

array

Returns ZodArray<ZodDate>

brand

Type Parameters

Parameters

Returns ZodBranded<ZodDate, B>

catch

Parameters

Returns ZodCatch<ZodDate>

Parameters

Returns ZodCatch<ZodDate>

default

Parameters

Returns ZodDefault<ZodDate>

Parameters

Returns ZodDefault<ZodDate>

describe

Parameters

Returns this

isNullable

Returns boolean

isOptional

`Readonly`_def

`Readonly`_input

`Readonly`_output

`Readonly`_type

`Static`create