Skip to main content

Class: BooleanValidator<T>

Extends

Type Parameters

Type ParameterDefault type
T extends booleanboolean

Constructors

new BooleanValidator()

new BooleanValidator<T>(validatorOptions: ValidatorOptions, constraints: readonly IConstraint<T, T>[]): BooleanValidator<T>

Parameters

ParameterTypeDefault value
validatorOptionsValidatorOptions{}
constraintsreadonly IConstraint<T, T>[][]

Returns

BooleanValidator<T>

Inherited from

BaseValidator.constructor

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:22

Properties

constraints

protected constraints: readonly IConstraint<T, T>[] = []

Inherited from

BaseValidator.constraints

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:19


description?

optional description: string

Inherited from

BaseValidator.description

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:16


isValidationEnabled

protected isValidationEnabled: null | boolean | () => boolean = null

Inherited from

BaseValidator.isValidationEnabled

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:20


parent?

protected optional parent: object

Inherited from

BaseValidator.parent

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:18


validatorOptions

protected validatorOptions: ValidatorOptions

Inherited from

BaseValidator.validatorOptions

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:17

Accessors

shouldRunConstraints

get protected shouldRunConstraints(): boolean

Returns

boolean

Inherited from

BaseValidator.shouldRunConstraints

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:143

Methods

addConstraint()

protected addConstraint(constraint: IConstraint<T, T>, validatorOptions: ValidatorOptions): this

Parameters

ParameterType
constraintIConstraint<T, T>
validatorOptionsValidatorOptions

Returns

this

Inherited from

BaseValidator.addConstraint

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:155


array()

array(options: ValidatorOptions): ArrayValidator<T[], T>

Parameters

ParameterType
optionsValidatorOptions

Returns

ArrayValidator<T[], T>

Inherited from

BaseValidator.array

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:44


clone()

protected clone(): this

Returns

this

Inherited from

BaseValidator.clone

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:147


default()

default(value: Exclude<T, undefined> | () => Exclude<T, undefined>, options: ValidatorOptions): DefaultValidator<Exclude<T, undefined>>

Parameters

ParameterType
valueExclude<T, undefined> | () => Exclude<T, undefined>
optionsValidatorOptions

Returns

DefaultValidator<Exclude<T, undefined>>

Inherited from

BaseValidator.default

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:81


describe()

describe(description: string): this

Parameters

ParameterType
descriptionstring

Returns

this

Inherited from

BaseValidator.describe

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:96


equal()

equal<R>(value: R, options: ValidatorOptions): BooleanValidator<R>

Type Parameters

Type Parameter
R extends boolean

Parameters

ParameterType
valueR
optionsValidatorOptions

Returns

BooleanValidator<R>

Defined in

projects/shapeshift/src/validators/BooleanValidator.ts:17


false()

false(options: ValidatorOptions): BooleanValidator<false>

Parameters

ParameterType
optionsValidatorOptions

Returns

BooleanValidator<false>

Defined in

projects/shapeshift/src/validators/BooleanValidator.ts:13


getValidationEnabled()

getValidationEnabled(): null | boolean

Returns

null | boolean

Inherited from

BaseValidator.getValidationEnabled

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:139


handle()

protected handle(value: unknown): Result<T, ValidationError>

Parameters

ParameterType
valueunknown

Returns

Result<T, ValidationError>

Overrides

BaseValidator.handle

Defined in

projects/shapeshift/src/validators/BooleanValidator.ts:25


is()

is<R>(value: unknown): value is R

Type Parameters

Type ParameterDefault type
R extends booleanT

Parameters

ParameterType
valueunknown

Returns

value is R

Inherited from

BaseValidator.is

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:124


notEqual()

notEqual<R>(value: R, options: ValidatorOptions): BooleanValidator<R>

Type Parameters

Type Parameter
R extends boolean

Parameters

ParameterType
valueR
optionsValidatorOptions

Returns

BooleanValidator<R>

Defined in

projects/shapeshift/src/validators/BooleanValidator.ts:21


nullable()

nullable(options: ValidatorOptions): UnionValidator<null | T>

Parameters

ParameterType
optionsValidatorOptions

Returns

UnionValidator<null | T>

Inherited from

BaseValidator.nullable

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:36


nullish()

nullish(options: ValidatorOptions): UnionValidator<undefined | null | T>

Parameters

ParameterType
optionsValidatorOptions

Returns

UnionValidator<undefined | null | T>

Inherited from

BaseValidator.nullish

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:40


optional()

optional(options: ValidatorOptions): UnionValidator<undefined | T>

Parameters

ParameterType
optionsValidatorOptions

Returns

UnionValidator<undefined | T>

Inherited from

BaseValidator.optional

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:32


or()

or<O>(...predicates: readonly BaseValidator<O>[]): UnionValidator<T | O>

Type Parameters

Type Parameter
O

Parameters

ParameterType
...predicatesreadonly BaseValidator<O>[]

Returns

UnionValidator<T | O>

Inherited from

BaseValidator.or

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:52


parse()

parse<R>(value: unknown): R

Type Parameters

Type ParameterDefault type
R extends booleanT

Parameters

ParameterType
valueunknown

Returns

R

Inherited from

BaseValidator.parse

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:114


reshape()

reshape(cb, options)

reshape(cb: (input: T) => Result<T, Error>, options?: ValidatorOptions): this

Parameters
ParameterType
cb(input: T) => Result<T, Error>
options?ValidatorOptions
Returns

this

Inherited from

BaseValidator.reshape

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:67

reshape(cb, options)

reshape<R, O>(cb: (input: T) => R, options?: ValidatorOptions): BaseValidator<O>

Type Parameters
Type ParameterDefault type
R extends Result<unknown, Error>-
OInferResultType<R>
Parameters
ParameterType
cb(input: T) => R
options?ValidatorOptions
Returns

BaseValidator<O>

Inherited from

BaseValidator.reshape

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:68


run()

run(value: unknown): Result<T, BaseError>

Parameters

ParameterType
valueunknown

Returns

Result<T, BaseError>

Inherited from

BaseValidator.run

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:102


set()

set(options: ValidatorOptions): SetValidator<T>

Parameters

ParameterType
optionsValidatorOptions

Returns

SetValidator<T>

Inherited from

BaseValidator.set

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:48


setParent()

setParent(parent: object): this

Parameters

ParameterType
parentobject

Returns

this

Inherited from

BaseValidator.setParent

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:27


setValidationEnabled()

setValidationEnabled(isValidationEnabled: null | boolean | () => boolean): this

Sets if the validator should also run constraints or just do basic checks.

Parameters

ParameterTypeDescription
isValidationEnablednull | boolean | () => booleanWhether this validator should be enabled or disabled. You can pass boolean or a function returning boolean which will be called just before parsing. Set to null to go off of the global configuration.

Returns

this

Inherited from

BaseValidator.setValidationEnabled

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:133


transform()

transform(cb, options)

transform(cb: (value: T) => T, options?: ValidatorOptions): this

Parameters
ParameterType
cb(value: T) => T
options?ValidatorOptions
Returns

this

Inherited from

BaseValidator.transform

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:56

transform(cb, options)

transform<O>(cb: (value: T) => O, options?: ValidatorOptions): BaseValidator<O>

Type Parameters
Type Parameter
O
Parameters
ParameterType
cb(value: T) => O
options?ValidatorOptions
Returns

BaseValidator<O>

Inherited from

BaseValidator.transform

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:57


true()

true(options: ValidatorOptions): BooleanValidator<true>

Parameters

ParameterType
optionsValidatorOptions

Returns

BooleanValidator<true>

Defined in

projects/shapeshift/src/validators/BooleanValidator.ts:9


when()

when<Key, This>(key: Key, options: WhenOptions<This, Key>, validatorOptions?: ValidatorOptions): this

Type Parameters

Type ParameterDefault type
Key extends WhenKey-
This extends BaseValidator<any>BooleanValidator<T>

Parameters

ParameterType
keyKey
optionsWhenOptions<This, Key>
validatorOptions?ValidatorOptions

Returns

this

Inherited from

BaseValidator.when

Defined in

projects/shapeshift/src/validators/BaseValidator.ts:88