Class: TupleValidator<T>
Extends
BaseValidator
<[...T
]>
Type Parameters
Type Parameter |
---|
T extends any [] |
Constructors
new TupleValidator()
new TupleValidator<
T
>(validators
:BaseValidator
<[...T[]
]>[],validatorOptions
:ValidatorOptions
,constraints
: readonlyIConstraint
<[...T[]
], [...T[]
]>[]):TupleValidator
<T
>
Parameters
Parameter | Type | Default value |
---|---|---|
validators | BaseValidator <[...T[] ]>[] | undefined |
validatorOptions | ValidatorOptions | {} |
constraints | readonly IConstraint <[...T[] ], [...T[] ]>[] | [] |
Returns
Overrides
Defined in
projects/shapeshift/src/validators/TupleValidator.ts:12
Properties
constraints
protected
constraints: readonlyIConstraint
<[...T[]
], [...T[]
]>[] =[]
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:19
description?
optional
description:string
Inherited from
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
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
Parameter | Type |
---|---|
constraint | IConstraint <[...T[] ], [...T[] ]> |
validatorOptions | ValidatorOptions |
Returns
this
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:155
array()
array(
options
:ValidatorOptions
):ArrayValidator
<[...T[]
][], [...T[]
]>
Parameters
Parameter | Type |
---|---|
options | ValidatorOptions |
Returns
ArrayValidator
<[...T[]
][], [...T[]
]>
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:44
clone()
protected
clone():this
Returns
this
Overrides
Defined in
projects/shapeshift/src/validators/TupleValidator.ts:21
default()
default(
value
:Exclude
<[...T[]
],undefined
> | () =>Exclude
<[...T[]
],undefined
>,options
:ValidatorOptions
):DefaultValidator
<Exclude
<[...T[]
],undefined
>>
Parameters
Parameter | Type |
---|---|
value | Exclude <[...T[] ], undefined > | () => Exclude <[...T[] ], undefined > |
options | ValidatorOptions |
Returns
DefaultValidator
<Exclude
<[...T[]
], undefined
>>
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:81
describe()
describe(
description
:string
):this
Parameters
Parameter | Type |
---|---|
description | string |
Returns
this
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:96
getValidationEnabled()
getValidationEnabled():
null
|boolean