Class: ArraySchema<T, C, TIn, TOut>

yup.ArraySchema

Type parameters

Name	Type
`T`	extends `AnySchema` \| `Lazy`<`any`, `any`>
`C`	extends `AnyObject` = `AnyObject`
`TIn`	extends `Maybe`<`TypeOf`<`T`>[]> = `TypeOf`<`T`>[] \| `undefined`
`TOut`	extends `Maybe`<`Asserts`<`T`>[]> = `Asserts`<`T`>[] \| `Optionals`<`TIn`>

Hierarchy

BaseSchema<TIn, C, TOut>
↳ ArraySchema

Constructors

constructor

• new ArraySchema<T, C, TIn, TOut>(type?)

Type parameters

Name	Type
`T`	extends `AnySchema`<`any`, `any`, `any`> \| `Lazy`<`any`, `any`>
`C`	extends `AnyObject` = `AnyObject`
`TIn`	extends `Maybe`<`TypeOf`<`T`>[]> = `undefined` \| `TypeOf`<`T`>[]
`TOut`	extends `Maybe`<`Asserts`<`T`>[]> = `Asserts`<`T`>[] \| `Extract`<`TIn`, `undefined` \| `null`>

Parameters

Name	Type
`type?`	`T`

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

_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

innerType

• Optional innerType: T

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

_subType

• Private get _subType(): any

Returns

any

_type

• get _type(): string

Returns

string

Inherited from

BaseSchema._type

Methods

_cast

▸ Protected _cast(_value, _opts): any

Parameters

Name	Type
`_value`	`any`
`_opts`	`InternalOptions`<`C`>

Returns

any

Overrides

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<TIn>

Parameters

Name	Type
`v`	`any`

Returns

v is NonNullable<TIn>

Overrides

BaseSchema._typeCheck

_validate

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

Parameters

Name	Type
`_value`	`any`
`options`	`undefined` \| `InternalOptions`<`C`>
`callback`	`Callback`<`any`>

Returns

void

Overrides

BaseSchema._validate

cast

▸ cast(value, options?): TIn

Parameters

Name	Type
`value`	`any`
`options?`	`CastOptions`<`C`>

Returns

TIn

Inherited from

BaseSchema.cast

clone

▸ clone(spec?): ArraySchema<T, C, TIn, TOut>

Parameters

Name	Type
`spec?`	`SchemaSpec`<`any`>

Returns

ArraySchema<T, C, TIn, TOut>

Overrides

BaseSchema.clone

compact

▸ compact(rejector?): ArraySchema<T, C, TIn, TOut>

Parameters

Name	Type
`rejector?`	`RejectorFn`

Returns

ArraySchema<T, C, TIn, TOut>

concat

▸ concat<TOther>(schema): TOther

Type parameters

Name	Type
`TOther`	extends `ArraySchema`<`any`, `any`, `any`, `any`, `TOther`>

Parameters

Name	Type
`schema`	`TOther`

Returns

TOther

Overrides

BaseSchema.concat

▸ concat(schema): any

Parameters

Name	Type
`schema`	`any`

Returns

any

Overrides

BaseSchema.concat

default

▸ default(def): any

Parameters

Name	Type
`def`	`any`

Returns

any

Inherited from

BaseSchema.default

defined

▸ defined(): DefinedArraySchema<T, C, TIn>

Returns

DefinedArraySchema<T, C, TIn>

Overrides

BaseSchema.defined

describe

▸ describe(): SchemaInnerTypeDescription

Returns

SchemaInnerTypeDescription

Overrides

BaseSchema.describe

ensure

▸ ensure(): RequiredArraySchema<T, C, TIn>

Returns

RequiredArraySchema<T, C, TIn>

getDefault

▸ getDefault(options?): TIn

Parameters

Name	Type
`options?`	`ResolveOptions`<`any`>

Returns

TIn

Inherited from

BaseSchema.getDefault

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`<`C`>

Returns

Promise<boolean>

Inherited from

BaseSchema.isValid

isValidSync

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

Parameters

Name	Type
`value`	`any`
`options?`	`ValidateOptions`<`C`>

Returns

value is TOut

Inherited from

BaseSchema.isValidSync

label

▸ label(label): ArraySchema<T, C, TIn, TOut>

Parameters

Name	Type
`label`	`string`

Returns

ArraySchema<T, C, TIn, TOut>

Inherited from

BaseSchema.label

length

▸ length(length, message?): ArraySchema<T, C, TIn, TOut>

Parameters

Name	Type
`length`	`number` \| `default`<`number`>
`message?`	`Message`<{ `length`: `number` }>

Returns

ArraySchema<T, C, TIn, TOut>

max

▸ max(max, message?): ArraySchema<T, C, TIn, TOut>

Parameters

Name	Type
`max`	`number` \| `default`<`number`>
`message?`	`Message`<{ `max`: `number` }>

Returns

ArraySchema<T, C, TIn, TOut>

Name	Type
`obj`	`Record`<`string`, `unknown`>

min

▸ min(min, message?): ArraySchema<T, C, TIn, TOut>

Parameters

Name	Type
`min`	`number` \| `default`<`number`>
`message?`	`Message`<{ `min`: `number` }>

Returns

ArraySchema<T, C, TIn, TOut>

notOneOf

▸ notOneOf<U>(enums, message?): ArraySchema<T, C, TIn, TOut>

Type parameters

Name	Type
`U`	extends `Maybe`<`TypeOf`<`T`>[]>

Parameters

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

Returns

ArraySchema<T, C, TIn, TOut>

Inherited from

BaseSchema.notOneOf

notRequired

▸ notRequired(): any

Returns

any

Inherited from

BaseSchema.notRequired

nullable

▸ nullable(isNullable?): ArraySchema<T, C, null | TIn, null | Asserts<T>[] | Extract<TIn, undefined | null>>

Parameters

Name	Type
`isNullable?`	`true`

Returns

ArraySchema<T, C, null | TIn, null | Asserts<T>[] | Extract<TIn, undefined | null>>

Overrides

BaseSchema.nullable

▸ nullable(isNullable): ArraySchema<T, C, Exclude<TIn, null>, Asserts<T>[] | Extract<Exclude<TIn, null>, undefined | null>>

Parameters

Name	Type
`isNullable`	`false`

Returns

ArraySchema<T, C, Exclude<TIn, null>, Asserts<T>[] | Extract<Exclude<TIn, null>, undefined | null>>

Overrides

BaseSchema.nullable

of

▸ of<TInner>(schema): ArraySchema<TInner, AnyObject, undefined | TypeOf<TInner>[], undefined | Asserts<TInner>[]>

Type parameters

Name	Type
`TInner`	extends `BaseSchema`<`any`, `any`, `any`, `TInner`>

Parameters

Name	Type
`schema`	`TInner`

Returns

ArraySchema<TInner, AnyObject, undefined | TypeOf<TInner>[], undefined | Asserts<TInner>[]>

oneOf

▸ oneOf<U>(enums, message?): ArraySchema<T, C, TIn, TOut>

Type parameters

Name	Type
`U`	extends `Maybe`<`TypeOf`<`T`>[]>

Parameters

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

Returns

ArraySchema<T, C, TIn, TOut>

Inherited from

BaseSchema.oneOf

optional

▸ optional(): any

Returns

any

Inherited from

BaseSchema.optional

required

▸ required(msg?): RequiredArraySchema<T, C, TIn>

Parameters

Name	Type
`msg?`	`Message`<{}>

Returns

RequiredArraySchema<T, C, TIn>

Overrides

BaseSchema.required

resolve

▸ resolve(options): ArraySchema<T, C, TIn, TOut>

Parameters

Name	Type
`options`	`ResolveOptions`<`any`>

Returns

ArraySchema<T, C, TIn, TOut>

Inherited from

BaseSchema.resolve

strict

▸ strict(isStrict?): ArraySchema<T, C, TIn, TOut>

Parameters

Name	Type
`isStrict?`	`boolean`

Returns

ArraySchema<T, C, TIn, TOut>

Inherited from

BaseSchema.strict

strip

▸ strip(strip?): ArraySchema<T, C, TIn, TOut>

Parameters

Name	Type
`strip?`	`boolean`

Returns

ArraySchema<T, C, TIn, TOut>

Inherited from

BaseSchema.strip

test

▸ test(options): ArraySchema<T, C, 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`, `C`>

Returns

ArraySchema<T, C, TIn, TOut>

Inherited from

BaseSchema.test

▸ test(test): ArraySchema<T, C, TIn, TOut>

Parameters

Name	Type
`test`	`TestFunction`<`TIn`, `C`>

Returns

ArraySchema<T, C, TIn, TOut>

Inherited from

BaseSchema.test

▸ test(name, test): ArraySchema<T, C, TIn, TOut>

Parameters

Name	Type
`name`	`string`
`test`	`TestFunction`<`TIn`, `C`>

Returns

ArraySchema<T, C, TIn, TOut>

Inherited from

BaseSchema.test

▸ test(name, message, test): ArraySchema<T, C, TIn, TOut>

Parameters

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

Returns

ArraySchema<T, C, TIn, TOut>

Inherited from

BaseSchema.test

transform

▸ transform(fn): ArraySchema<T, C, TIn, TOut>

Parameters

Name	Type
`fn`	`TransformFunction`<`ArraySchema`<`T`, `C`, `TIn`, `TOut`>>

Returns

ArraySchema<T, C, TIn, TOut>

Inherited from

BaseSchema.transform

typeError

▸ typeError(message): ArraySchema<T, C, TIn, TOut>

Parameters

Name	Type
`message`	`Message`<{}>

Returns

ArraySchema<T, C, TIn, TOut>

Inherited from

BaseSchema.typeError

validate

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

Parameters

Name	Type
`value`	`any`
`options?`	`ValidateOptions`<`C`>

Returns

Promise<TOut>

Inherited from

BaseSchema.validate

validateAt

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

Parameters

Name	Type
`path`	`string`
`value`	`any`
`options?`	`ValidateOptions`<`C`>

Returns

Promise<TOut>

Inherited from

BaseSchema.validateAt

validateSync

▸ validateSync(value, options?): TOut

Parameters

Name	Type
`value`	`any`
`options?`	`ValidateOptions`<`C`>

Returns

TOut

Inherited from

BaseSchema.validateSync

validateSyncAt

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

Parameters

Name	Type
`path`	`string`
`value`	`any`
`options?`	`ValidateOptions`<`C`>

Returns

TOut

Inherited from

BaseSchema.validateSyncAt

when

▸ when(options): ArraySchema<T, C, TIn, TOut>

Parameters

Name	Type
`options`	`ConditionOptions`<`ArraySchema`<`T`, `C`, `TIn`, `TOut`>>

Returns

ArraySchema<T, C, TIn, TOut>

Inherited from

BaseSchema.when

▸ when(keys, options): ArraySchema<T, C, TIn, TOut>

Parameters

Name	Type
`keys`	`string` \| `string`[]
`options`	`ConditionOptions`<`ArraySchema`<`T`, `C`, `TIn`, `TOut`>>

Returns

ArraySchema<T, C, TIn, TOut>

Inherited from

BaseSchema.when

withMutation

▸ withMutation<T>(fn): T

Type parameters

Name
`T`

Parameters

Name	Type
`fn`	(`schema`: `ArraySchema`<`T`, `C`, `TIn`, `TOut`>) => `T`

Returns

T

Inherited from

BaseSchema.withMutation

Type parameters​

Hierarchy​

Constructors​

constructor​

Type parameters​

Parameters​

Overrides​

Properties​

__inputType​

Inherited from​

__isYupSchema__​

Inherited from​

__outputType​

Inherited from​

_blacklist​

Inherited from​

_whitelist​

Inherited from​

deps​

Inherited from​

equals​

Type declaration​

Type parameters​

Parameters​

Returns​

Inherited from​

exclusiveTests​

Inherited from​

innerType​

is​

Type declaration​

Type parameters​

Parameters​

Returns​

Inherited from​

nope​

Type declaration​

Type parameters​

Parameters​

Returns​

Inherited from​

not​

Type declaration​

Type parameters​

Parameters​

Returns​

Inherited from​

spec​

Inherited from​

tests​

Inherited from​

transforms​

Inherited from​

type​

Inherited from​

Accessors​

_subType​

Returns​

_type​

Returns​

Inherited from​

Methods​

_cast​

Parameters​

Returns​

Overrides​

_getDefault​

Returns​

Inherited from​

_isPresent​

Parameters​

Returns​

Inherited from​

_typeCheck​

Parameters​

Returns​

Overrides​

_validate​

Parameters​

Returns​

Type parameters

Hierarchy

Constructors

constructor

Type parameters

Parameters

Overrides

Properties

__inputType

Inherited from

isYupSchema

Inherited from

__outputType

Inherited from

_blacklist

Inherited from

_whitelist

Inherited from

deps

Inherited from

equals

Type declaration

Type parameters

Parameters

Returns

Inherited from

exclusiveTests

Inherited from

innerType

is

Type declaration

Type parameters

Parameters

Returns

Inherited from

nope

Type declaration

Type parameters

Parameters

Returns

Inherited from

not

Type declaration

Type parameters

Parameters

Returns

Inherited from

spec

Inherited from

tests

Inherited from

transforms

Inherited from

type

Inherited from

Accessors

_subType

Returns

_type

Returns

Inherited from

Methods

_cast

Parameters

Returns

Overrides

_getDefault

Returns

Inherited from

_isPresent

Parameters

Returns

Inherited from

_typeCheck

Parameters

Returns

Overrides

_validate

Parameters

Returns