BooleanSchema
Generated by TypeDoc. Do not edit this page directly.
Class: BooleanSchema
Section titled “Class: BooleanSchema”Defined in: packages/core/src/schema/index.ts:226
Extends
Section titled “Extends”Schema<unknown,boolean>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new BooleanSchema(): BooleanSchema;Returns
Section titled “Returns”BooleanSchema
Inherited from
Section titled “Inherited from”Properties
Section titled “Properties”| Property | Modifier | Type | Default value | Inherited from | Defined in |
|---|---|---|---|---|---|
isHarnessSchema | readonly | true | true | Schema.isHarnessSchema | packages/core/src/schema/index.ts:76 |
Methods
Section titled “Methods”default()
Section titled “default()”default(value): DefaultSchema<unknown, boolean>;Defined in: packages/core/src/schema/index.ts:92
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value | boolean | (() => boolean) |
Returns
Section titled “Returns”DefaultSchema<unknown, boolean>
Inherited from
Section titled “Inherited from”describe()
Section titled “describe()”describe(description): this;Defined in: packages/core/src/schema/index.ts:96
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
description | string |
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”optional()
Section titled “optional()”optional(): OptionalSchema<unknown, boolean | undefined>;Defined in: packages/core/src/schema/index.ts:88
Returns
Section titled “Returns”OptionalSchema<unknown, boolean | undefined>
Inherited from
Section titled “Inherited from”parse()
Section titled “parse()”parse(input): boolean;Defined in: packages/core/src/schema/index.ts:82
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
input | unknown |
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”safeParse()
Section titled “safeParse()”safeParse(input): SafeParseResult<boolean>;Defined in: packages/core/src/schema/index.ts:227
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
input | unknown |
Returns
Section titled “Returns”SafeParseResult<boolean>
Overrides
Section titled “Overrides”toJsonSchema()
Section titled “toJsonSchema()”toJsonSchema(): JsonSchema;Defined in: packages/core/src/schema/index.ts:233