Class ZodBoolean

Hierarchy (View Summary)

Zod.ZodType<boolean, Zod.ZodBooleanDef>
- ZodBoolean

Index

Constructors

constructor

new ZodBoolean(def: Zod.ZodBooleanDef): Zod.ZodBoolean
Parameters
- def: Zod.ZodBooleanDef
Returns Zod.ZodBoolean
Inherited from ZodType.constructor

Properties

`Readonly`_def

_def: Zod.ZodBooleanDef

`Readonly`_input

_input: boolean

`Readonly`_output

_output: boolean

`Readonly`_type

_type: boolean

spa

spa: (
data: unknown,
params?: Partial<Zod.ParseParams>,
) => Promise<Zod.SafeParseReturnType<boolean, boolean>>

Alias of safeParseAsync

`Static`create

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

Accessors

description

get description(): undefined | string
Returns undefined | string
Inherited from ZodType.description

Methods

_getOrReturnCtx

_getOrReturnCtx(input: Zod.ParseInput, ctx?: Zod.ParseContext): Zod.ParseContext
Parameters
- input: Zod.ParseInput
- Optionalctx: Zod.ParseContext
Returns Zod.ParseContext
Inherited from ZodType._getOrReturnCtx

_getType

_getType(input: Zod.ParseInput): string
Parameters
- input: Zod.ParseInput
Returns string
Inherited from ZodType._getType

_parse

_parse(input: Zod.ParseInput): Zod.ParseReturnType<boolean>
Parameters
- input: Zod.ParseInput
Returns Zod.ParseReturnType<boolean>
Overrides ZodType._parse

_parseAsync

_parseAsync(input: Zod.ParseInput): Zod.AsyncParseReturnType<boolean>
Parameters
- input: Zod.ParseInput
Returns Zod.AsyncParseReturnType<boolean>
Inherited from ZodType._parseAsync

_parseSync

_parseSync(input: Zod.ParseInput): Zod.SyncParseReturnType<boolean>
Parameters
- input: Zod.ParseInput
Returns Zod.SyncParseReturnType<boolean>
Inherited from ZodType._parseSync

_processInputParams

_processInputParams(
input: Zod.ParseInput,
): { ctx: Zod.ParseContext; status: Zod.ParseStatus }
Parameters
- input: Zod.ParseInput
Returns { ctx: Zod.ParseContext; status: Zod.ParseStatus }
Inherited from ZodType._processInputParams

_refinement

_refinement(
refinement: (arg: boolean, ctx: Zod.RefinementCtx) => any,
): Zod.ZodEffects<Zod.ZodBoolean, boolean, boolean>
Parameters
- refinement: (arg: boolean, ctx: Zod.RefinementCtx) => any
Returns Zod.ZodEffects<Zod.ZodBoolean, boolean, boolean>
Inherited from ZodType._refinement

and

and<T extends Zod.ZodTypeAny>(
incoming: T,
): Zod.ZodIntersection<Zod.ZodBoolean, T>
Type Parameters
- T extends Zod.ZodTypeAny
Parameters
- incoming: T
Returns Zod.ZodIntersection<Zod.ZodBoolean, T>
Inherited from ZodType.and

array

array(): Zod.ZodArray<Zod.ZodBoolean>
Returns Zod.ZodArray<Zod.ZodBoolean>
Inherited from ZodType.array

brand

brand<B extends string | number | symbol>(
brand?: B,
): Zod.ZodBranded<Zod.ZodBoolean, B>
Type Parameters
- B extends string | number | symbol
Parameters
- Optionalbrand: B
Returns Zod.ZodBranded<Zod.ZodBoolean, B>
Inherited from ZodType.brand

catch

catch(def: boolean): Zod.ZodCatch<Zod.ZodBoolean>
Parameters
- def: boolean
Returns Zod.ZodCatch<Zod.ZodBoolean>
Inherited from ZodType.catch
catch(
def: (ctx: { error: Zod.ZodError; input: boolean }) => boolean,
): Zod.ZodCatch<Zod.ZodBoolean>
Parameters
- def: (ctx: { error: Zod.ZodError; input: boolean }) => boolean
Returns Zod.ZodCatch<Zod.ZodBoolean>
Inherited from ZodType.catch

default

default(def: boolean): Zod.ZodDefault<Zod.ZodBoolean>
Parameters
- def: boolean
Returns Zod.ZodDefault<Zod.ZodBoolean>
Inherited from ZodType.default
default(def: () => boolean): Zod.ZodDefault<Zod.ZodBoolean>
Parameters
- def: () => boolean
Returns Zod.ZodDefault<Zod.ZodBoolean>
Inherited from ZodType.default

describe

describe(description: string): this
Parameters
- description: string
Returns this
Inherited from ZodType.describe

isNullable

isNullable(): boolean
Returns boolean
Inherited from ZodType.isNullable

isOptional

isOptional(): boolean
Returns boolean
Inherited from ZodType.isOptional

nullable

nullable(): Zod.ZodNullable<Zod.ZodBoolean>
Returns Zod.ZodNullable<Zod.ZodBoolean>
Inherited from ZodType.nullable

nullish

nullish(): Zod.ZodOptional<Zod.ZodNullable<Zod.ZodBoolean>>
Returns Zod.ZodOptional<Zod.ZodNullable<Zod.ZodBoolean>>
Inherited from ZodType.nullish

optional

optional(): Zod.ZodOptional<Zod.ZodBoolean>
Returns Zod.ZodOptional<Zod.ZodBoolean>
Inherited from ZodType.optional

or

or<T extends Zod.ZodTypeAny>(option: T): Zod.ZodUnion<[Zod.ZodBoolean, T]>
Type Parameters
- T extends Zod.ZodTypeAny
Parameters
- option: T
Returns Zod.ZodUnion<[Zod.ZodBoolean, T]>
Inherited from ZodType.or

parse

parse(data: unknown, params?: Partial<Zod.ParseParams>): boolean
Parameters
- data: unknown
- Optionalparams: Partial<Zod.ParseParams>
Returns boolean
Inherited from ZodType.parse

parseAsync

parseAsync(data: unknown, params?: Partial<Zod.ParseParams>): Promise<boolean>
Parameters
- data: unknown
- Optionalparams: Partial<Zod.ParseParams>
Returns Promise<boolean>
Inherited from ZodType.parseAsync

pipe

pipe<T extends Zod.ZodTypeAny>(target: T): Zod.ZodPipeline<Zod.ZodBoolean, T>
Type Parameters
- T extends Zod.ZodTypeAny
Parameters
- target: T
Returns Zod.ZodPipeline<Zod.ZodBoolean, T>
Inherited from ZodType.pipe

promise

promise(): Zod.ZodPromise<Zod.ZodBoolean>
Returns Zod.ZodPromise<Zod.ZodBoolean>
Inherited from ZodType.promise

readonly

readonly(): Zod.ZodReadonly<Zod.ZodBoolean>
Returns Zod.ZodReadonly<Zod.ZodBoolean>
Inherited from ZodType.readonly

refine

refine<RefinedOutput extends boolean>(
    check: (arg: boolean) => arg is RefinedOutput,
    message?:
        | string
        | Partial<Omit<Zod.ZodCustomIssue, "code">>
        | ((arg: boolean) => Zod.CustomErrorParams),
): Zod.ZodEffects<Zod.ZodBoolean, RefinedOutput, boolean>
Type Parameters
- RefinedOutput extends boolean
Parameters
- check: (arg: boolean) => arg is RefinedOutput
- Optionalmessage:
      | string
      | Partial<Omit<Zod.ZodCustomIssue, "code">>
      | ((arg: boolean) => Zod.CustomErrorParams)
Returns Zod.ZodEffects<Zod.ZodBoolean, RefinedOutput, boolean>
Inherited from ZodType.refine
refine(
    check: (arg: boolean) => unknown,
    message?:
        | string
        | Partial<Omit<Zod.ZodCustomIssue, "code">>
        | ((arg: boolean) => Zod.CustomErrorParams),
): Zod.ZodEffects<Zod.ZodBoolean, boolean, boolean>
Parameters
- check: (arg: boolean) => unknown
- Optionalmessage:
      | string
      | Partial<Omit<Zod.ZodCustomIssue, "code">>
      | ((arg: boolean) => Zod.CustomErrorParams)
Returns Zod.ZodEffects<Zod.ZodBoolean, boolean, boolean>
Inherited from ZodType.refine

refinement<RefinedOutput extends boolean>(
    check: (arg: boolean) => arg is RefinedOutput,
    refinementData:
        | Zod.IssueData
        | ((arg: boolean, ctx: Zod.RefinementCtx) => Zod.IssueData),
): Zod.ZodEffects<Zod.ZodBoolean, RefinedOutput, boolean>
Type Parameters
- RefinedOutput extends boolean
Parameters
- check: (arg: boolean) => arg is RefinedOutput
- refinementData: Zod.IssueData | ((arg: boolean, ctx: Zod.RefinementCtx) => Zod.IssueData)
Returns Zod.ZodEffects<Zod.ZodBoolean, RefinedOutput, boolean>
Inherited from ZodType.refinement
refinement(
    check: (arg: boolean) => boolean,
    refinementData:
        | Zod.IssueData
        | ((arg: boolean, ctx: Zod.RefinementCtx) => Zod.IssueData),
): Zod.ZodEffects<Zod.ZodBoolean, boolean, boolean>
Parameters
- check: (arg: boolean) => boolean
- refinementData: Zod.IssueData | ((arg: boolean, ctx: Zod.RefinementCtx) => Zod.IssueData)
Returns Zod.ZodEffects<Zod.ZodBoolean, boolean, boolean>
Inherited from ZodType.refinement

safeParse

safeParse(
data: unknown,
params?: Partial<Zod.ParseParams>,
): Zod.SafeParseReturnType<boolean, boolean>
Parameters
- data: unknown
- Optionalparams: Partial<Zod.ParseParams>
Returns Zod.SafeParseReturnType<boolean, boolean>
Inherited from ZodType.safeParse

safeParseAsync

safeParseAsync(
data: unknown,
params?: Partial<Zod.ParseParams>,
): Promise<Zod.SafeParseReturnType<boolean, boolean>>
Parameters
- data: unknown
- Optionalparams: Partial<Zod.ParseParams>
Returns Promise<Zod.SafeParseReturnType<boolean, boolean>>
Inherited from ZodType.safeParseAsync

superRefine

superRefine<RefinedOutput extends boolean>(
    refinement: (
        arg: boolean,
        ctx: Zod.RefinementCtx,
    ) => arg is RefinedOutput,
): Zod.ZodEffects<Zod.ZodBoolean, RefinedOutput, boolean>
Type Parameters
- RefinedOutput extends boolean
Parameters
- refinement: (arg: boolean, ctx: Zod.RefinementCtx) => arg is RefinedOutput
Returns Zod.ZodEffects<Zod.ZodBoolean, RefinedOutput, boolean>
Inherited from ZodType.superRefine
superRefine(
refinement: (arg: boolean, ctx: Zod.RefinementCtx) => void,
): Zod.ZodEffects<Zod.ZodBoolean, boolean, boolean>
Parameters
- refinement: (arg: boolean, ctx: Zod.RefinementCtx) => void
Returns Zod.ZodEffects<Zod.ZodBoolean, boolean, boolean>
Inherited from ZodType.superRefine
superRefine(
refinement: (arg: boolean, ctx: Zod.RefinementCtx) => Promise<void>,
): Zod.ZodEffects<Zod.ZodBoolean, boolean, boolean>
Parameters
- refinement: (arg: boolean, ctx: Zod.RefinementCtx) => Promise<void>
Returns Zod.ZodEffects<Zod.ZodBoolean, boolean, boolean>
Inherited from ZodType.superRefine

transform

transform<NewOut>(
    transform: (
        arg: boolean,
        ctx: Zod.RefinementCtx,
    ) => NewOut | Promise<NewOut>,
): Zod.ZodEffects<Zod.ZodBoolean, NewOut>
Type Parameters
- NewOut
Parameters
- transform: (arg: boolean, ctx: Zod.RefinementCtx) => NewOut | Promise<NewOut>
Returns Zod.ZodEffects<Zod.ZodBoolean, NewOut>
Inherited from ZodType.transform

Class ZodBoolean

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Zod.ZodBoolean

Properties

Readonly_def

Readonly_input

Readonly_output

Readonly_type

spa

Staticcreate

Accessors

description

Returns undefined | string

Methods

_getOrReturnCtx

Parameters

Returns Zod.ParseContext

_getType

Parameters

Returns string

_parse

Parameters

Returns Zod.ParseReturnType<boolean>

_parseAsync

Parameters

Returns Zod.AsyncParseReturnType<boolean>

_parseSync

Parameters

Returns Zod.SyncParseReturnType<boolean>

_processInputParams

Parameters

Returns { ctx: Zod.ParseContext; status: Zod.ParseStatus }

_refinement

Parameters

Returns Zod.ZodEffects<Zod.ZodBoolean, boolean, boolean>

and

Type Parameters

Parameters

Returns Zod.ZodIntersection<Zod.ZodBoolean, T>

array

Returns Zod.ZodArray<Zod.ZodBoolean>

brand

Type Parameters

Parameters

Returns Zod.ZodBranded<Zod.ZodBoolean, B>

catch

Parameters

Returns Zod.ZodCatch<Zod.ZodBoolean>

Parameters

Returns Zod.ZodCatch<Zod.ZodBoolean>

default

Parameters

Returns Zod.ZodDefault<Zod.ZodBoolean>

Parameters

Returns Zod.ZodDefault<Zod.ZodBoolean>

describe

Parameters

Returns this

isNullable

Returns boolean

isOptional

Returns boolean

nullable

Returns Zod.ZodNullable<Zod.ZodBoolean>

nullish

Returns Zod.ZodOptional<Zod.ZodNullable<Zod.ZodBoolean>>

optional

Returns Zod.ZodOptional<Zod.ZodBoolean>

or

Type Parameters

Parameters

Returns Zod.ZodUnion<[Zod.ZodBoolean, T]>

`Readonly`_def

`Readonly`_input

`Readonly`_output

`Readonly`_type

`Static`create