Class: BooleanValidator<T>

Type parameters

Name	Type
T	extends boolean = boolean

Hierarchy

• BaseValidator<T>

  ↳ BooleanValidator

Constructors

constructor

• new BooleanValidator<T>(constraints?): BooleanValidator<T>

Type parameters

Name	Type
T	extends boolean = boolean

Parameters

Name	Type	Default value
constraints	readonly IConstraint<T, T>[]	[]

Returns

BooleanValidator<T>

Inherited from

BaseValidator.constructor

Defined in

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

Properties

constraints

• Protected constraints: readonly IConstraint<T, T>[] = []

Inherited from

BaseValidator.constraints

Defined in

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

---

description

• Optional description: string

Inherited from

BaseValidator.description

Defined in

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

---

isValidationEnabled

• Protected isValidationEnabled: null | boolean | () => boolean = null

Inherited from

BaseValidator.isValidationEnabled

Defined in

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

---

parent

• Protected Optional parent: object

Inherited from

BaseValidator.parent

Defined in

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

Accessors

array

• get array(): ArrayValidator<T[], T>

Returns

ArrayValidator<T[], T>

Inherited from

BaseValidator.array

Defined in

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

---

false

• get false(): BooleanValidator<false>

Returns

BooleanValidator<false>

Defined in

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

---

nullable

• get nullable(): UnionValidator<null | T>

Returns

UnionValidator<null | T>

Inherited from

BaseValidator.nullable

Defined in

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

---

nullish

• get nullish(): UnionValidator<undefined | null | T>

Returns

UnionValidator<undefined | null | T>

Inherited from

BaseValidator.nullish

Defined in

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

---

optional

• get optional(): UnionValidator<undefined | T>

Returns

UnionValidator<undefined | T>

Inherited from

BaseValidator.optional

Defined in

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

---

set

• get set(): SetValidator<T>

Returns

SetValidator<T>

Inherited from

BaseValidator.set

Defined in

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

---

shouldRunConstraints

• get shouldRunConstraints(): boolean

Returns

boolean

Inherited from

BaseValidator.shouldRunConstraints

Defined in

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

---

true

• get true(): BooleanValidator<true>

Returns

BooleanValidator<true>

Defined in

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

Methods

addConstraint

▸ addConstraint(constraint): BooleanValidator<T>

Parameters

Name	Type
constraint	IConstraint<T, T>

Returns

BooleanValidator<T>

Inherited from

BaseValidator.addConstraint

Defined in

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

---

clone

▸ clone(): BooleanValidator<T>

Returns

BooleanValidator<T>

Inherited from

BaseValidator.clone

Defined in

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

---

default

▸ default(value): DefaultValidator<Exclude<T, undefined>>

Parameters

Name	Type
value	Exclude<T, undefined> | () => Exclude<T, undefined>

Returns

DefaultValidator<Exclude<T, undefined>>

Inherited from

BaseValidator.default

Defined in

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

---

describe

▸ describe(description): BooleanValidator<T>

Parameters

Name	Type
description	string

Returns

BooleanValidator<T>

Inherited from

BaseValidator.describe

Defined in

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

---

equal

▸ equal<R>(value): BooleanValidator<R>

Type parameters

Name	Type
R	extends boolean

Parameters

Name	Type
value	R

Returns

BooleanValidator<R>

Defined in

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

---

getValidationEnabled

▸ getValidationEnabled(): null | boolean

Returns

null | boolean

Inherited from

BaseValidator.getValidationEnabled

Defined in

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

---

handle

▸ handle(value): Result<T, ValidationError>

Parameters

Name	Type
value	unknown

Returns

Result<T, ValidationError>

Overrides

BaseValidator.handle

Defined in

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

---

is

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

Type parameters

Name	Type
R	extends boolean = T

Parameters

Name	Type
value	unknown

Returns

value is R

Inherited from

BaseValidator.is

Defined in

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

---

notEqual

▸ notEqual<R>(value): BooleanValidator<R>

Type parameters

Name	Type
R	extends boolean

Parameters

Name	Type
value	R

Returns

BooleanValidator<R>

Defined in

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

---

or

▸ or<O>(...predicates): UnionValidator<T | O>

Type parameters

Name
O

Parameters

Name	Type
...predicates	readonly BaseValidator<O>[]

Returns

UnionValidator<T | O>

Inherited from

BaseValidator.or

Defined in

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

---

parse

▸ parse<R>(value): R

Type parameters

Name	Type
R	extends boolean = T

Parameters

Name	Type
value	unknown

Returns

R

Inherited from

BaseValidator.parse

Defined in

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

---

reshape

▸ reshape(cb): BooleanValidator<T>

Parameters

Name	Type
cb	(input: T) => Result<T, Error>

Returns

BooleanValidator<T>

Inherited from

BaseValidator.reshape

Defined in

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

▸ reshape<R, O>(cb): BaseValidator<O>

Type parameters

Name	Type
R	extends Result<unknown, Error>
O	InferResultType<R>

Parameters

Name	Type
cb	(input: T) => R

Returns

BaseValidator<O>

Inherited from

BaseValidator.reshape

Defined in

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

---

run

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

Parameters

Name	Type
value	unknown

Returns

Result<T, BaseError>

Inherited from

BaseValidator.run

Defined in

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

---

setParent

▸ setParent(parent): BooleanValidator<T>

Parameters

Name	Type
parent	object

Returns

BooleanValidator<T>

Inherited from

BaseValidator.setParent

Defined in

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

---

setValidationEnabled

▸ setValidationEnabled(isValidationEnabled): BooleanValidator<T>

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

Parameters

Name	Type	Description
isValidationEnabled	null | boolean | () => boolean	Whether 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

BooleanValidator<T>

Inherited from

BaseValidator.setValidationEnabled

Defined in

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

---

transform

▸ transform(cb): BooleanValidator<T>

Parameters

Name	Type
cb	(value: T) => T

Returns

BooleanValidator<T>

Inherited from

BaseValidator.transform

Defined in

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

▸ transform<O>(cb): BaseValidator<O>

Type parameters

Name
O

Parameters

Name	Type
cb	(value: T) => O

Returns

BaseValidator<O>

Inherited from

BaseValidator.transform

Defined in

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

---

when

▸ when<Key, This>(key, options): BooleanValidator<T>

Type parameters

Name	Type
Key	extends WhenKey
This	extends BaseValidator<any> = BooleanValidator<T>

Parameters

Name	Type
key	Key
options	WhenOptions<This, Key>

Returns

BooleanValidator<T>

Inherited from

BaseValidator.when

Defined in

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