Class: ObjectSchema<TShape, TContext, TIn, TOut>

yup.ObjectSchema

Type parameters

Name	Type
TShape	extends ObjectShape
TContext	extends AnyObject = AnyObject
TIn	extends Maybe<TypeOfShape<TShape>> = TypeOfShape<TShape>
TOut	extends Maybe<AssertsShape<TShape>> = AssertsShape<TShape> | Optionals<TIn>

Hierarchy

• BaseSchema<TIn, TContext, TOut>

  ↳ ObjectSchema

Constructors

constructor

• new ObjectSchema<TShape, TContext, TIn, TOut>(spec?)

Type parameters

Name	Type
TShape	extends ObjectShape
TContext	extends AnyObject = AnyObject
TIn	extends Maybe<TypeOfShape<TShape>> = TypeOfShape<TShape>
TOut	extends Maybe<AssertsShape<TShape>> = AssertsShape<TShape> | Extract<TIn, undefined | null>

Parameters

Name	Type
spec?	TShape

Overrides

BaseSchema.constructor

Properties

__inputType

• Readonly __inputType: TIn

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

---

_excludedEdges

• Private _excludedEdges: any

---

_nodes

• Private _nodes: any

---

_sortErrors

• Private _sortErrors: any

---

_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

---

fields

• fields: TShape

---

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: ObjectSchemaSpec

Overrides

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(_value, options?): any

Parameters

Name	Type
_value	any
options?	InternalOptions<TContext>

Returns

any

Overrides

BaseSchema._cast

---

_getDefault

▸ Protected _getDefault(): any

Returns

any

Overrides

BaseSchema._getDefault

---

_isPresent

▸ Protected _isPresent(value): boolean

Parameters

Name	Type
value	unknown

Returns

boolean

Inherited from

BaseSchema._isPresent

---

_typeCheck

▸ Protected _typeCheck(value): value is NonNullable<TIn>

Parameters

Name	Type
value	any

Returns

value is NonNullable<TIn>

Overrides

BaseSchema._typeCheck

---

_validate

▸ Protected _validate(_value, opts, callback): void

Parameters

Name	Type
_value	any
opts	undefined | InternalOptions<TContext>
callback	Callback<any>

Returns

void

Overrides

BaseSchema._validate

---

camelCase

▸ camelCase(): ObjectSchema<TShape, TContext, TIn, TOut>

Returns

ObjectSchema<TShape, TContext, TIn, TOut>

---

cast

▸ cast(value, options?): TIn

Parameters

Name	Type
value	any
options?	CastOptions<TContext>

Returns

TIn

Inherited from

BaseSchema.cast

---

clone

▸ clone(spec?): ObjectSchema<TShape, TContext, TIn, TOut>

Parameters

Name	Type
spec?	ObjectSchemaSpec

Returns

ObjectSchema<TShape, TContext, TIn, TOut>

Overrides

BaseSchema.clone

---

concat

▸ concat<TOther>(schema): TOther extends ObjectSchema<S, C, IType, AssertsShape<S> | Extract<IType, undefined | null>> ? ObjectSchema<TShape & S, TContext & C, Extract<IType, undefined | null> | TypeOfShape<TShape & S>, AssertsShape<TShape & S> | Extract<Extract<IType, undefined | null>, undefined | null> | Extract<TypeOfShape<TShape & S>, undefined | null>> : never

Type parameters

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

Parameters

Name	Type
schema	TOther

Returns

TOther extends ObjectSchema<S, C, IType, AssertsShape<S> | Extract<IType, undefined | null>> ? ObjectSchema<TShape & S, TContext & C, Extract<IType, undefined | null> | TypeOfShape<TShape & S>, AssertsShape<TShape & S> | Extract<Extract<IType, undefined | null>, undefined | null> | Extract<TypeOfShape<TShape & S>, undefined | null>> : never

Overrides

BaseSchema.concat

▸ concat(schema): ObjectSchema<TShape, TContext, TIn, TOut>

Parameters

Name	Type
schema	ObjectSchema<TShape, TContext, TIn, TOut>

Returns

ObjectSchema<TShape, TContext, TIn, TOut>

Overrides

BaseSchema.concat

---

constantCase

▸ constantCase(): ObjectSchema<TShape, TContext, TIn, TOut>

Returns

ObjectSchema<TShape, TContext, TIn, TOut>

---

default

▸ default(def): any

Parameters

Name	Type
def	any

Returns

any

Inherited from

BaseSchema.default

---

defined

▸ defined(message?): any

Parameters

Name	Type
message?	Message<{}>

Returns

any

Inherited from

BaseSchema.defined

---

describe

▸ describe(): SchemaObjectDescription

Returns

SchemaObjectDescription

Overrides

BaseSchema.describe

---

from

▸ from(from, to, alias?): ObjectSchema<TShape, TContext, TIn, TOut>

Parameters

Name	Type
from	string
to	keyof TShape
alias?	boolean

Returns

ObjectSchema<TShape, TContext, TIn, TOut>

---

getDefault

▸ getDefault(options?): TIn

Parameters

Name	Type
options?	ResolveOptions<any>

Returns

TIn

Inherited from

BaseSchema.getDefault

---

getDefaultFromShape

▸ getDefaultFromShape(): DefaultFromShape<TShape>

Returns

DefaultFromShape<TShape>

---

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): ObjectSchema<TShape, TContext, TIn, TOut>

Parameters

Name	Type
label	string

Returns

ObjectSchema<TShape, TContext, TIn, TOut>

Inherited from

BaseSchema.label

---

meta

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

Returns

undefined | Record<string, unknown>

Inherited from

BaseSchema.meta

▸ meta(obj): ObjectSchema<TShape, TContext, TIn, TOut>

Parameters

Name	Type
obj	Record<string, unknown>

Returns

ObjectSchema<TShape, TContext, TIn, TOut>

Inherited from

BaseSchema.meta

---

noUnknown

▸ noUnknown(noAllow?, message?): ObjectSchema<TShape, TContext, TIn, TOut>

Parameters

Name	Type
noAllow?	boolean
message?	Message<{}>

Returns

ObjectSchema<TShape, TContext, TIn, TOut>

---

notOneOf

▸ notOneOf<U>(enums, message?): ObjectSchema<TShape, TContext, TIn, TOut>

Type parameters

Name	Type
U	extends Maybe<TypeOfShape<TShape>>

Parameters

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

Returns

ObjectSchema<TShape, TContext, TIn, TOut>

Inherited from

BaseSchema.notOneOf

---

notRequired

▸ notRequired(): any

Returns

any

Inherited from

BaseSchema.notRequired

---

nullable

▸ nullable(isNullable?): any

Parameters

Name	Type
isNullable?	true

Returns

any

Inherited from

BaseSchema.nullable

▸ nullable(isNullable): any

Parameters

Name	Type
isNullable	false

Returns

any

Inherited from

BaseSchema.nullable

---

omit

▸ omit(keys): any

Parameters

Name	Type
keys	string[]

Returns

any

---

oneOf

▸ oneOf<U>(enums, message?): ObjectSchema<TShape, TContext, TIn, TOut>

Type parameters

Name	Type
U	extends Maybe<TypeOfShape<TShape>>

Parameters

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

Returns

ObjectSchema<TShape, TContext, TIn, TOut>

Inherited from

BaseSchema.oneOf

---

optional

▸ optional(): any

Returns

any

Inherited from

BaseSchema.optional

---

pick

▸ pick(keys): any

Parameters

Name	Type
keys	string[]

Returns

any

---

required

▸ required(message?): any

Parameters

Name	Type
message?	Message<{}>

Returns

any

Inherited from

BaseSchema.required

---

resolve

▸ resolve(options): ObjectSchema<TShape, TContext, TIn, TOut>

Parameters

Name	Type
options	ResolveOptions<any>

Returns

ObjectSchema<TShape, TContext, TIn, TOut>

Inherited from

BaseSchema.resolve

---

shape

▸ shape<TNextShape>(additions, excludes?): ObjectSchema<Assign<TShape, TNextShape>, TContext, Extract<TIn, undefined | null> | TypeOfShape<Assign<TShape, TNextShape>>, AssertsShape<Assign<TShape, TNextShape>> | Extract<Extract<TIn, undefined | null>, undefined | null> | Extract<TypeOfShape<Assign<TShape, TNextShape>>, undefined | null>>

Type parameters

Name	Type
TNextShape	extends ObjectShape

Parameters

Name	Type
additions	TNextShape
excludes?	[string, string][]

Returns

ObjectSchema<Assign<TShape, TNextShape>, TContext, Extract<TIn, undefined | null> | TypeOfShape<Assign<TShape, TNextShape>>, AssertsShape<Assign<TShape, TNextShape>> | Extract<Extract<TIn, undefined | null>, undefined | null> | Extract<TypeOfShape<Assign<TShape, TNextShape>>, undefined | null>>

---

snakeCase

▸ snakeCase(): ObjectSchema<TShape, TContext, TIn, TOut>

Returns

ObjectSchema<TShape, TContext, TIn, TOut>

---

strict

▸ strict(isStrict?): ObjectSchema<TShape, TContext, TIn, TOut>

Parameters

Name	Type
isStrict?	boolean

Returns

ObjectSchema<TShape, TContext, TIn, TOut>

Inherited from

BaseSchema.strict

---

strip

▸ strip(strip?): ObjectSchema<TShape, TContext, TIn, TOut>

Parameters

Name	Type
strip?	boolean

Returns

ObjectSchema<TShape, TContext, TIn, TOut>

Inherited from

BaseSchema.strip

---

test

▸ test(options): ObjectSchema<TShape, TContext, TIn, 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<TIn, TContext>

Returns

ObjectSchema<TShape, TContext, TIn, TOut>

Inherited from

BaseSchema.test

▸ test(test): ObjectSchema<TShape, TContext, TIn, TOut>

Parameters

Name	Type
test	TestFunction<TIn, TContext>

Returns

ObjectSchema<TShape, TContext, TIn, TOut>

Inherited from

BaseSchema.test

▸ test(name, test): ObjectSchema<TShape, TContext, TIn, TOut>

Parameters

Name	Type
name	string
test	TestFunction<TIn, TContext>

Returns

ObjectSchema<TShape, TContext, TIn, TOut>

Inherited from

BaseSchema.test

▸ test(name, message, test): ObjectSchema<TShape, TContext, TIn, TOut>

Parameters

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

Returns

ObjectSchema<TShape, TContext, TIn, TOut>

Inherited from

BaseSchema.test

---

transform

▸ transform(fn): ObjectSchema<TShape, TContext, TIn, TOut>

Parameters

Name	Type
fn	TransformFunction<ObjectSchema<TShape, TContext, TIn, TOut>>

Returns

ObjectSchema<TShape, TContext, TIn, TOut>

Inherited from

BaseSchema.transform

---

transformKeys

▸ transformKeys(fn): ObjectSchema<TShape, TContext, TIn, TOut>

Parameters

Name	Type
fn	(key: string) => string

Returns

ObjectSchema<TShape, TContext, TIn, TOut>

---

typeError

▸ typeError(message): ObjectSchema<TShape, TContext, TIn, TOut>

Parameters

Name	Type
message	Message<{}>

Returns

ObjectSchema<TShape, TContext, TIn, TOut>

Inherited from

BaseSchema.typeError

---

unknown

▸ unknown(allow?, message?): ObjectSchema<TShape, TContext, TIn, TOut>

Parameters

Name	Type
allow?	boolean
message?	Message<{}>

Returns

ObjectSchema<TShape, TContext, TIn, TOut>

---

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): ObjectSchema<TShape, TContext, TIn, TOut>

Parameters

Name	Type
options	ConditionOptions<ObjectSchema<TShape, TContext, TIn, TOut>>

Returns

ObjectSchema<TShape, TContext, TIn, TOut>

Inherited from

BaseSchema.when

▸ when(keys, options): ObjectSchema<TShape, TContext, TIn, TOut>

Parameters

Name	Type
keys	string | string[]
options	ConditionOptions<ObjectSchema<TShape, TContext, TIn, TOut>>

Returns

ObjectSchema<TShape, TContext, TIn, TOut>

Inherited from

BaseSchema.when

---

withMutation

▸ withMutation<T>(fn): T

Type parameters

Name
T

Parameters

Name	Type
fn	(schema: ObjectSchema<TShape, TContext, TIn, TOut>) => T

Returns

T

Inherited from

BaseSchema.withMutation