Class: BooleanSchema<TType, TContext, TOut>

yup.BooleanSchema

Type parameters

Name	Type
TType	extends Maybe<boolean> = boolean | undefined
TContext	extends AnyObject = AnyObject
TOut	extends TType = TType

Hierarchy

• BaseSchema<TType, TContext, TOut>

  ↳ BooleanSchema

Constructors

constructor

• new BooleanSchema<TType, TContext, TOut>()

Type parameters

Name	Type
TType	extends Maybe<boolean> = undefined | boolean
TContext	extends AnyObject = AnyObject
TOut	extends Maybe<boolean> = TType

Overrides

BaseSchema.constructor

Properties

__inputType

• Readonly __inputType: TType

Inherited from

BaseSchema.__inputType

---

__isYupSchema__

• Readonly __isYupSchema__: boolean

Inherited from

BaseSchema.isYupSchema

---

__outputType

• Readonly __outputType: TOut

Inherited from

BaseSchema.__outputType

---

_blacklist

• Protected _blacklist: default

Inherited from

BaseSchema._blacklist

---

_whitelist

• Protected _whitelist: default

Inherited from

BaseSchema._whitelist

---

deps

• Readonly deps: readonly string[]

Inherited from

BaseSchema.deps

---

equals

• equals: <U>(enums: (default<unknown> | Maybe<U>)[], message?: Message<{ values: any }>) => BaseSchema<any, AnyObject, any>

Type declaration

▸ <U>(enums, message?): BaseSchema<any, AnyObject, any>

Type parameters

Name	Type
U	extends any

Parameters

Name	Type
enums	(default<unknown> | Maybe<U>)[]
message?	Message<{ values: any }>

Returns

BaseSchema<any, AnyObject, any>

Inherited from

BaseSchema.equals

---

exclusiveTests

• Protected exclusiveTests: Record<string, boolean>

Inherited from

BaseSchema.exclusiveTests

---

is

• is: <U>(enums: (default<unknown> | Maybe<U>)[], message?: Message<{ values: any }>) => BaseSchema<any, AnyObject, any>

Type declaration

▸ <U>(enums, message?): BaseSchema<any, AnyObject, any>

Type parameters

Name	Type
U	extends any

Parameters

Name	Type
enums	(default<unknown> | Maybe<U>)[]
message?	Message<{ values: any }>

Returns

BaseSchema<any, AnyObject, any>

Inherited from

BaseSchema.is

---

nope

• nope: <U>(enums: (default<unknown> | Maybe<U>)[], message?: Message<{ values: any }>) => BaseSchema<any, AnyObject, any>

Type declaration

▸ <U>(enums, message?): BaseSchema<any, AnyObject, any>

Type parameters

Name	Type
U	extends any

Parameters

Name	Type
enums	(default<unknown> | Maybe<U>)[]
message?	Message<{ values: any }>

Returns

BaseSchema<any, AnyObject, any>

Inherited from

BaseSchema.nope

---

not

• not: <U>(enums: (default<unknown> | Maybe<U>)[], message?: Message<{ values: any }>) => BaseSchema<any, AnyObject, any>

Type declaration

▸ <U>(enums, message?): BaseSchema<any, AnyObject, any>

Type parameters

Name	Type
U	extends any

Parameters

Name	Type
enums	(default<unknown> | Maybe<U>)[]
message?	Message<{ values: any }>

Returns

BaseSchema<any, AnyObject, any>

Inherited from

BaseSchema.not

---

spec

• spec: SchemaSpec<any>

Inherited from

BaseSchema.spec

---

tests

• tests: Test[]

Inherited from

BaseSchema.tests

---

transforms

• transforms: TransformFunction<AnySchema<any, any, any>>[]

Inherited from

BaseSchema.transforms

---

type

• Readonly type: string

Inherited from

BaseSchema.type

Accessors

_type

• get _type(): string

Returns

string

Inherited from

BaseSchema._type

Methods

_cast

▸ Protected _cast(rawValue, _options): any

Parameters

Name	Type
rawValue	any
_options	CastOptions<TContext>

Returns

any

Inherited from

BaseSchema._cast

---

_getDefault

▸ Protected _getDefault(): any

Returns

any

Inherited from

BaseSchema._getDefault

---

_isPresent

▸ Protected _isPresent(value): boolean

Parameters

Name	Type
value	unknown

Returns

boolean

Inherited from

BaseSchema._isPresent

---

_typeCheck

▸ Protected _typeCheck(v): v is NonNullable<TType>

Parameters

Name	Type
v	any

Returns

v is NonNullable<TType>

Overrides

BaseSchema._typeCheck

---

_validate

▸ Protected _validate(_value, options, cb): void

Parameters

Name	Type
_value	any
options	undefined | InternalOptions<TContext>
cb	Callback<any>

Returns

void

Inherited from

BaseSchema._validate

---

cast

▸ cast(value, options?): TType

Parameters

Name	Type
value	any
options?	CastOptions<TContext>

Returns

TType

Inherited from

BaseSchema.cast

---

clone

▸ clone(spec?): BooleanSchema<TType, TContext, TOut>

Parameters

Name	Type
spec?	Partial<SchemaSpec<any>>

Returns

BooleanSchema<TType, TContext, TOut>

Inherited from

BaseSchema.clone

---

concat

▸ concat<TOther>(schema): TOther

Type parameters

Name	Type
TOther	extends BooleanSchema<any, any, any, TOther>

Parameters

Name	Type
schema	TOther

Returns

TOther

Inherited from

BaseSchema.concat

---

default

▸ default<TNextDefault>(def): TNextDefault extends undefined ? BooleanSchema<undefined | TType, TContext, undefined | TType> : BooleanSchema<Defined<TType>, TContext, Defined<TType>>

Type parameters

Name	Type
TNextDefault	extends Maybe<boolean>

Parameters

Name	Type
def	TNextDefault | () => TNextDefault

Returns

TNextDefault extends undefined ? BooleanSchema<undefined | TType, TContext, undefined | TType> : BooleanSchema<Defined<TType>, TContext, Defined<TType>>

Inherited from

BaseSchema.default

---

defined

▸ defined(msg?): DefinedBooleanSchema<TType, TContext>

Parameters

Name	Type
msg?	Message<{}>

Returns

DefinedBooleanSchema<TType, TContext>

Inherited from

BaseSchema.defined

---

describe

▸ describe(): SchemaDescription

Returns

SchemaDescription

Inherited from

BaseSchema.describe

---

getDefault

▸ getDefault(options?): TType

Parameters

Name	Type
options?	ResolveOptions<any>

Returns

TType

Inherited from

BaseSchema.getDefault

---

isFalse

▸ isFalse(message?): BooleanSchema<false | TType, TContext, false | Extract<TOut, undefined | null>>

Parameters

Name	Type
message?	string | Record<string | number | symbol, unknown> | (params: MessageParams) => unknown

Returns

BooleanSchema<false | TType, TContext, false | Extract<TOut, undefined | null>>

---

isTrue

▸ isTrue(message?): BooleanSchema<true | TType, TContext, true | Extract<TOut, undefined | null>>

Parameters

Name	Type
message?	string | Record<string | number | symbol, unknown> | (params: MessageParams) => unknown

Returns

BooleanSchema<true | TType, TContext, true | Extract<TOut, undefined | null>>

---

isType

▸ isType(v): boolean

Parameters

Name	Type
v	any

Returns

boolean

Inherited from

BaseSchema.isType

---

isValid

▸ isValid(value, options?): Promise<boolean>

Parameters

Name	Type
value	any
options?	ValidateOptions<TContext>

Returns

Promise<boolean>

Inherited from

BaseSchema.isValid

---

isValidSync

▸ isValidSync(value, options?): value is TOut

Parameters

Name	Type
value	any
options?	ValidateOptions<TContext>

Returns

value is TOut

Inherited from

BaseSchema.isValidSync

---

label

▸ label(label): BooleanSchema<TType, TContext, TOut>

Parameters

Name	Type
label	string

Returns

BooleanSchema<TType, TContext, TOut>

Inherited from

BaseSchema.label

---

meta

▸ meta(): undefined | Record<string, unknown>

Returns

undefined | Record<string, unknown>

Inherited from

BaseSchema.meta

▸ meta(obj): BooleanSchema<TType, TContext, TOut>

Parameters

Name	Type
obj	Record<string, unknown>

Returns

BooleanSchema<TType, TContext, TOut>

Inherited from

BaseSchema.meta

---

notOneOf

▸ notOneOf<U>(enums, message?): BooleanSchema<TType, TContext, TOut>

Type parameters

Name	Type
U	extends Maybe<boolean>

Parameters

Name	Type
enums	(default<unknown> | Maybe<U>)[]
message?	Message<{ values: any }>

Returns

BooleanSchema<TType, TContext, TOut>

Inherited from

BaseSchema.notOneOf

---

notRequired

▸ notRequired(): BooleanSchema<TType, TContext, TType>

Returns

BooleanSchema<TType, TContext, TType>

Inherited from

BaseSchema.notRequired

---

nullable

▸ nullable(isNullable?): BooleanSchema<null | TType, AnyObject, null | TType>

Parameters

Name	Type
isNullable?	true

Returns

BooleanSchema<null | TType, AnyObject, null | TType>

Inherited from

BaseSchema.nullable

▸ nullable(isNullable): BooleanSchema<Exclude<TType, null>, AnyObject, Exclude<TType, null>>

Parameters

Name	Type
isNullable	false

Returns

BooleanSchema<Exclude<TType, null>, AnyObject, Exclude<TType, null>>

Inherited from

BaseSchema.nullable

---

oneOf

▸ oneOf<U>(enums, message?): BooleanSchema<TType, TContext, TOut>

Type parameters

Name	Type
U	extends Maybe<boolean>

Parameters

Name	Type
enums	(default<unknown> | Maybe<U>)[]
message?	Message<{ values: any }>

Returns

BooleanSchema<TType, TContext, TOut>

Inherited from

BaseSchema.oneOf

---

optional

▸ optional(): BooleanSchema<TType, TContext, TType>

Returns

BooleanSchema<TType, TContext, TType>

Inherited from

BaseSchema.optional

---

required

▸ required(msg?): RequiredBooleanSchema<TType, TContext>

Parameters

Name	Type
msg?	Message<{}>

Returns

RequiredBooleanSchema<TType, TContext>

Inherited from

BaseSchema.required

---

resolve

▸ resolve(options): BooleanSchema<TType, TContext, TOut>

Parameters

Name	Type
options	ResolveOptions<any>

Returns

BooleanSchema<TType, TContext, TOut>

Inherited from

BaseSchema.resolve

---

strict

▸ strict(isStrict?): BooleanSchema<TType, TContext, TOut>

Parameters

Name	Type
isStrict?	boolean

Returns

BooleanSchema<TType, TContext, TOut>

Inherited from

BaseSchema.strict

---

strip

▸ strip(strip?): BooleanSchema<TType, TContext, TOut>

Parameters

Name	Type
strip?	boolean

Returns

BooleanSchema<TType, TContext, TOut>

Inherited from

BaseSchema.strip

---

test

▸ test(options): BooleanSchema<TType, TContext, TOut>

Adds a test function to the schema's queue of tests. tests can be exclusive or non-exclusive.

• exclusive tests, will replace any existing tests of the same name.
• non-exclusive: can be stacked

If a non-exclusive test is added to a schema with an exclusive test of the same name the exclusive test is removed and further tests of the same name will be stacked.

If an exclusive test is added to a schema with non-exclusive tests of the same name the previous tests are removed and further tests of the same name will replace each other.

Parameters

Name	Type
options	TestConfig<TType, TContext>

Returns

BooleanSchema<TType, TContext, TOut>

Inherited from

BaseSchema.test

▸ test(test): BooleanSchema<TType, TContext, TOut>

Parameters

Name	Type
test	TestFunction<TType, TContext>

Returns

BooleanSchema<TType, TContext, TOut>

Inherited from

BaseSchema.test

▸ test(name, test): BooleanSchema<TType, TContext, TOut>

Parameters

Name	Type
name	string
test	TestFunction<TType, TContext>

Returns

BooleanSchema<TType, TContext, TOut>

Inherited from

BaseSchema.test

▸ test(name, message, test): BooleanSchema<TType, TContext, TOut>

Parameters

Name	Type
name	string
message	Message<{}>
test	TestFunction<TType, TContext>

Returns

BooleanSchema<TType, TContext, TOut>

Inherited from

BaseSchema.test

---

transform

▸ transform(fn): BooleanSchema<TType, TContext, TOut>

Parameters

Name	Type
fn	TransformFunction<BooleanSchema<TType, TContext, TOut>>

Returns

BooleanSchema<TType, TContext, TOut>

Inherited from

BaseSchema.transform

---

typeError

▸ typeError(message): BooleanSchema<TType, TContext, TOut>

Parameters

Name	Type
message	Message<{}>

Returns

BooleanSchema<TType, TContext, TOut>

Inherited from

BaseSchema.typeError

---

validate

▸ validate(value, options?): Promise<TOut>

Parameters

Name	Type
value	any
options?	ValidateOptions<TContext>

Returns

Promise<TOut>

Inherited from

BaseSchema.validate

---

validateAt

▸ validateAt(path, value, options?): Promise<TOut>

Parameters

Name	Type
path	string
value	any
options?	ValidateOptions<TContext>

Returns

Promise<TOut>

Inherited from

BaseSchema.validateAt

---

validateSync

▸ validateSync(value, options?): TOut

Parameters

Name	Type
value	any
options?	ValidateOptions<TContext>

Returns

TOut

Inherited from

BaseSchema.validateSync

---

validateSyncAt

▸ validateSyncAt(path, value, options?): TOut

Parameters

Name	Type
path	string
value	any
options?	ValidateOptions<TContext>

Returns

TOut

Inherited from

BaseSchema.validateSyncAt

---

when

▸ when(options): BooleanSchema<TType, TContext, TOut>

Parameters

Name	Type
options	ConditionOptions<BooleanSchema<TType, TContext, TOut>>

Returns

BooleanSchema<TType, TContext, TOut>

Inherited from

BaseSchema.when

▸ when(keys, options): BooleanSchema<TType, TContext, TOut>

Parameters

Name	Type
keys	string | string[]
options	ConditionOptions<BooleanSchema<TType, TContext, TOut>>

Returns

BooleanSchema<TType, TContext, TOut>

Inherited from

BaseSchema.when

---

withMutation

▸ withMutation<T>(fn): T

Type parameters

Name
T

Parameters

Name	Type
fn	(schema: BooleanSchema<TType, TContext, TOut>) => T

Returns

T

Inherited from

BaseSchema.withMutation