Class: UnionValidator<T>
Type parameters
Name |
---|
T |
Hierarchy
↳
UnionValidator
Constructors
constructor
• new UnionValidator<T
>(validators
, constraints?
)
Type parameters
Name |
---|
T |
Parameters
Name | Type | Default value |
---|---|---|
validators | readonly BaseValidator <T >[] | undefined |
constraints | readonly IConstraint <T , T >[] | [] |
Overrides
Defined in
projects/shapeshift/src/validators/UnionValidator.ts:11
Properties
constraints
• Protected
constraints: readonly IConstraint
<T
, T
>[] = []
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:13
isValidationEnabled
• Protected
isValidationEnabled: null
| boolean
| () => boolean
= null
Inherited from
BaseValidator.isValidationEnabled
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:14
validators
• Private
validators: readonly BaseValidator
<T
>[]
Defined in
projects/shapeshift/src/validators/UnionValidator.ts:9
Accessors
array
• get
array(): ArrayValidator
<T
[], T
>
Returns
ArrayValidator
<T
[], T
>
Inherited from
BaseValidator.array
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:32
nullable
• get
nullable(): UnionValidator
<null
| T
>
Returns
UnionValidator
<null
| T
>
Overrides
BaseValidator.nullable
Defined in
projects/shapeshift/src/validators/UnionValidator.ts:54
nullish
• get
nullish(): UnionValidator
<undefined
| null
| T
>
Returns
UnionValidator
<undefined
| null
| T
>
Overrides
BaseValidator.nullish
Defined in
projects/shapeshift/src/validators/UnionValidator.ts:77
optional
• get
optional(): UnionValidator
<undefined
| T
>
Returns
UnionValidator
<undefined
| T
>
Overrides
BaseValidator.optional
Defined in
projects/shapeshift/src/validators/UnionValidator.ts:16
required
• get
required(): UnionValidator
<Exclude
<T
, undefined
>>
Returns
UnionValidator
<Exclude
<T
, undefined
>>
Defined in
projects/shapeshift/src/validators/UnionValidator.ts:39
set
• get
set(): SetValidator
<T
>
Returns
SetValidator
<T
>
Inherited from
BaseValidator.set
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:36
shouldRunConstraints
• Protected
get
shouldRunConstraints(): boolean
Returns
boolean
Inherited from
BaseValidator.shouldRunConstraints
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:91
Methods
addConstraint
▸ Protected
addConstraint(constraint
): UnionValidator
<T
>
Parameters
Name | Type |
---|---|
constraint | IConstraint <T , T > |
Returns
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:103
clone
▸ Protected
clone(): UnionValidator
<T
>
Returns
Overrides
Defined in
projects/shapeshift/src/validators/UnionValidator.ts:98
default
▸ default(value
): DefaultValidator
<Exclude
<T
, undefined
>>
Parameters
Name | Type |
---|---|
value | Exclude <T , undefined > | () => Exclude <T , undefined > |
Returns
DefaultValidator
<Exclude
<T
, undefined
>>
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:50
getValidationEnabled
▸ getValidationEnabled(): null
| boolean
Returns
null
| boolean
Inherited from
BaseValidator.getValidationEnabled
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:87
handle
▸ Protected
handle(value
): Result
<T
, CombinedError
| ValidationError
>
Parameters
Name | Type |
---|---|
value | unknown |
Returns
Result
<T
, CombinedError
| ValidationError
>
Overrides
Defined in
projects/shapeshift/src/validators/UnionValidator.ts:102
or
▸ or<O
>(...predicates
): UnionValidator
<T
| O
>
Type parameters
Name |
---|
O |
Parameters
Name | Type |
---|---|
...predicates | readonly BaseValidator <O >[] |
Returns
UnionValidator
<T
| O
>
Overrides
Defined in
projects/shapeshift/src/validators/UnionValidator.ts:94
parse
▸ parse<R
>(value
): R
Type parameters
Name | Type |
---|---|
R | T |
Parameters
Name | Type |
---|---|
value | unknown |
Returns
R
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:66
run
▸ run(value
): Result
<T
, BaseError
>
Parameters
Name | Type |
---|---|
value | unknown |
Returns
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:54
setValidationEnabled
▸ setValidationEnabled(isValidationEnabled
): UnionValidator
<T
>
Parameters
Name | Type | Description |
---|---|---|
isValidationEnabled | null | boolean | () => boolean |
Returns
Inherited from
BaseValidator.setValidationEnabled
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:81
transform
▸ transform(cb
): UnionValidator
<T
>
Parameters
Name | Type |
---|---|
cb | (value : T ) => T |
Returns
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:44
▸ transform<O
>(cb
): BaseValidator
<O
>
Type parameters
Name |
---|
O |
Parameters
Name | Type |
---|---|
cb | (value : T ) => O |