Class VineBoolean

VineBoolean represents a boolean value in the validation schema. It accepts boolean, string, and number inputs and converts them to booleans, with support for both strict and loose type checking.

Example

const schema = vine.boolean()

const result = await vine.validate({
  schema,
  data: "true" // Will be converted to true
})

Hierarchy (View Summary)

BaseLiteralType<boolean | string | number, boolean, boolean>
- VineBoolean

Index

Constructors

constructor

new VineBoolean(
options?: Partial<FieldOptions> & { strict?: boolean },
validations?: Validation<any>[],
): VineBoolean
Creates a new VineBoolean instance with optional configuration.
Parameters
- Optionaloptions: Partial<FieldOptions> & { strict?: boolean }
  Field options like bail mode, nullability and strict mode
- Optionalvalidations: Validation<any>[]
  Initial set of validations to apply
Returns VineBoolean
Overrides BaseLiteralType.constructor
- Defined in src/schema/boolean/main.ts:67

Properties

[ITYPE]

"[ITYPE]": string | number | boolean

Define the input type of the schema for TypeScript inference

[OTYPE]

"[OTYPE]": boolean

The output value type of the field after validation. The property points to a type only and not the real value.

[COTYPE]

"[COTYPE]": boolean

Type marker for camelCase output type inference

`Optional`dataTypeValidator

dataTypeValidator?: Validation<any>

The validation to use for validating the schema data type. Using a data type validator guards custom rules to only run when the data type validation passes.

Example

class StringSchema extends BaseLiteralType {
  dataTypeValidator = stringDataTypeRule
}

`Static`rules

rules: {
    boolean: (
        ...options: [options: { strict?: boolean }],
    ) => Validation<{ strict?: boolean }>;
} = ...

Static collection of all available validation rules for booleans

[SUBTYPE]

"[SUBTYPE]": string = 'boolean'

The subtype identifier for the literal schema field

[UNIQUE_NAME]

"[UNIQUE_NAME]": string = 'vine.boolean'

Unique name identifier for union type resolution

Methods

parse

parse(callback: ParseFn): this
Define a method to parse the input value. The method is invoked before any validation and hence you must perform type-checking to know the value you are working it.
Parameters
- callback: ParseFn
Returns this
Inherited from BaseLiteralType.parse
- Defined in src/schema/base/literal.ts:478

use

use(validation: Validation<any> | RuleBuilder): this
Adds a validation rule to the schema's validation chain. Rules are executed in the order they are added.
Parameters
- validation: Validation<any> | RuleBuilder
  The validation rule or rule builder to add
Returns this
This schema instance for method chaining
Example
```
vine.string().use(minLength({ length: 3 }))
vine.number().use(customRule({ strict: true }))
```
Inherited from BaseLiteralType.use
- Defined in src/schema/base/literal.ts:494

bail

bail(state: boolean): VineBoolean
Enable/disable bail mode for this field. In bail mode, field validations stop after the first error.
Parameters
- state: boolean
  Whether to enable bail mode
Returns VineBoolean
This schema instance for method chaining
Example
```
vine.string().bail(false) // Continue validation after first error
vine.number().bail(true)  // Stop after first error (default)
```
Inherited from BaseLiteralType.bail
- Defined in src/schema/base/literal.ts:510

optional

optional(): OptionalModifier<VineBoolean>
Mark the field under validation as optional. An optional field allows both null and undefined values.

Returns OptionalModifier<VineBoolean>
Inherited from BaseLiteralType.optional
- Defined in src/schema/base/literal.ts:519

nullable

nullable(): NullableModifier<VineBoolean>
Mark the field under validation to be null. The null value will be written to the output as well.

If optional and nullable are used together, then both undefined and null values will be allowed.

Returns NullableModifier<VineBoolean>
Inherited from BaseLiteralType.nullable
- Defined in src/schema/base/literal.ts:530

transform

transform<TransformedOutput>(
transformer: Transformer<VineBoolean, TransformedOutput>,
): TransformModifier<VineBoolean, TransformedOutput>
Apply transform on the final validated value. The transform method may convert the value to any new datatype.
Type Parameters
- TransformedOutput
Parameters
- transformer: Transformer<VineBoolean, TransformedOutput>
Returns TransformModifier<VineBoolean, TransformedOutput>
Inherited from BaseLiteralType.transform
- Defined in src/schema/base/literal.ts:538

[PARSE]

"[PARSE]"(
    propertyName: string,
    refs: RefsStore,
    options: ParserOptions,
): FieldNode & {} & { subtype: string }
Compiles the literal schema type into a compiler node. This method transforms the schema definition into a format that the validation compiler can process.
Parameters
- propertyName: string
  Name of the property being compiled
- refs: RefsStore
  Reference store for the compiler
- options: ParserOptions
  Parser options including camelCase conversion
Returns FieldNode & {} & { subtype: string }
Compiled literal node with subtype information
Inherited from BaseLiteralType.[PARSE]
- Defined in src/schema/base/literal.ts:554

[IS_OF_TYPE]

"[IS_OF_TYPE]"(value: unknown): boolean
Type checker function to determine if a value can be converted to a boolean. Required for "unionOfTypes" functionality.
Parameters
- value: unknown
  The value to check
Returns boolean
True if the value can be converted to a boolean
- Defined in src/schema/boolean/main.ts:56

clone

clone(): this
Clones the VineBoolean schema type. The applied options and validations are copied to the new instance.

Returns this
A cloned instance of this VineBoolean schema
Overrides BaseLiteralType.clone
- Defined in src/schema/boolean/main.ts:80

Class VineBoolean

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns VineBoolean

Properties

[ITYPE]

[OTYPE]

[COTYPE]

OptionaldataTypeValidator

Example

Staticrules

[SUBTYPE]

[UNIQUE_NAME]

Methods

parse

Parameters

Returns this

use

Parameters

Returns this

Example

bail

Parameters

Returns VineBoolean

Example

optional

Returns OptionalModifier<VineBoolean>

nullable

Returns NullableModifier<VineBoolean>

transform

Type Parameters

Parameters

Returns TransformModifier<VineBoolean, TransformedOutput>

[PARSE]

Parameters

Returns FieldNode & {} & { subtype: string }

[IS_OF_TYPE]

Parameters

Returns boolean

clone

Returns this

Settings

On This Page

`Optional`dataTypeValidator

`Static`rules