boolean

Creates a boolean schema.

// Boolean schema with an optional pipe
const Schema = boolean(pipe);

// Boolean schema with an optional message and pipe
const Schema = boolean(message, pipe);

Parameters

• message ErrorMessage | undefined
• pipe Pipe<boolean> | undefined

Explanation

With boolean you can validate the data type of the input and with pipe you can transform and validate the further details of the boolean. If the input is not a boolean, you can use message to customize the error message.

Instead of using the pipe to force true or false as a value, in most cases it makes more sense to use literal for better typing.

Returns

• Schema BooleanSchema

Examples

The following examples show how boolean can be used.

Custom message

Boolean schema with a custom error message.

const BooleanSchema = boolean('A boolean is required');

Related

The following APIs can be combined with boolean.

Schemas

• array,
• intersect,
• lazy,
• map,
• nonNullable,
• nonNullish,
• nonOptional,
• nullable,
• nullish,
• object,
• optional,
• record,
• set,
• tuple,
• union

Methods

• brand,
• coerce,
• fallback,
• getDefault,
• getDefaults,
• getFallback,
• getFallbacks,
• is,
• parse,
• safeParse,
• transform

Transformations

• toCustom,
• toMaxValue,
• toMinValue

Validations

• custom,
• maxValue,
• minValue,
• notValue,
• value