Class ZodBoolean

Hierarchy (View Summary)

ZodType<boolean, ZodBooleanDef, boolean>
- ZodBoolean

Index

Constructors

constructor

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

Properties

`Readonly`_type

_type: boolean

`Readonly`_output

_output: boolean

`Readonly`_input

_input: boolean

`Readonly`_def

_def: ZodBooleanDef

~standard

"~standard": Props<boolean, boolean>

spa

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

Alias of safeParseAsync

`Static`create

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

Accessors

description

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

Methods

_getType

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

_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

_processInputParams

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

_parseSync

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

_parseAsync

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

parse

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

safeParse

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

~validate

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

parseAsync

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

safeParseAsync

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

refine

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

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

_refinement

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

superRefine

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

optional

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

nullable

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

nullish

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

array

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

promise

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

or

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

and

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

transform

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

default

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

brand

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

catch

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

describe

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

pipe

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

readonly

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

isOptional

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

isNullable

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

_parse

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

Class ZodBoolean

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ZodBoolean

Properties

Readonly_type

Readonly_output

Readonly_input

Readonly_def

~standard

spa

Staticcreate

Accessors

description

Returns undefined | string

Methods

_getType

Parameters

Returns string

_getOrReturnCtx

Parameters

Returns ParseContext

_processInputParams

Parameters

Returns { status: ParseStatus; ctx: ParseContext }

_parseSync

Parameters

Returns SyncParseReturnType<boolean>

_parseAsync

Parameters

Returns AsyncParseReturnType<boolean>

parse

Parameters

Returns boolean

safeParse

Parameters

Returns SafeParseReturnType<boolean, boolean>

~validate

Parameters

Returns Result<boolean> | Promise<Result<boolean>>

parseAsync

Parameters

Returns Promise<boolean>

safeParseAsync

Parameters

Returns Promise<SafeParseReturnType<boolean, boolean>>

refine

Type Parameters

Parameters

Returns ZodEffects<ZodBoolean, RefinedOutput, boolean>

Parameters

Returns ZodEffects<ZodBoolean, boolean, boolean>

refinement

Type Parameters

Parameters

Returns ZodEffects<ZodBoolean, RefinedOutput, boolean>

Parameters

Returns ZodEffects<ZodBoolean, boolean, boolean>

_refinement

Parameters

Returns ZodEffects<ZodBoolean, boolean, boolean>

superRefine

Type Parameters

Parameters

Returns ZodEffects<ZodBoolean, RefinedOutput, boolean>

Parameters

Returns ZodEffects<ZodBoolean, boolean, boolean>

Parameters

Returns ZodEffects<ZodBoolean, boolean, boolean>

optional

Returns ZodOptional<ZodBoolean>

nullable

Returns ZodNullable<ZodBoolean>

`Readonly`_type

`Readonly`_output

`Readonly`_input

`Readonly`_def

`Static`create