Class: ObjectValidator<T>
Type parameters
Name | Type |
---|---|
T | extends NonNullObject |
Hierarchy
↳
ObjectValidator
Constructors
constructor
• new ObjectValidator<T
>(shape
, strategy?
, constraints?
)
Type parameters
Name | Type |
---|---|
T | extends NonNullObject |
Parameters
Name | Type | Default value |
---|---|---|
shape | MappedObjectValidator <T > | undefined |
strategy | ObjectValidatorStrategy | ObjectValidatorStrategy.Ignore |
constraints | readonly IConstraint <T , T >[] | [] |
Overrides
Defined in
projects/shapeshift/src/validators/ObjectValidator.ts:23
Properties
constraints
• Protected
constraints: readonly IConstraint
<T
, T
>[] = []
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:11
handleStrategy
• Private
Readonly
handleStrategy: (value
: NonNullObject
) => Result
<T
, CombinedPropertyError
>
Type declaration
▸ (value
): Result
<T
, CombinedPropertyError
>
Parameters
Name | Type |
---|---|
value | NonNullObject |
Returns
Result
<T
, CombinedPropertyError
>
Defined in
projects/shapeshift/src/validators/ObjectValidator.ts:18
keys
• Private
Readonly
keys: readonly keyof T
[] = []
Defined in
projects/shapeshift/src/validators/ObjectValidator.ts:17
possiblyUndefinedKeys
• Private
Readonly
possiblyUndefinedKeys: Map
<keyof T
, BaseValidator
<unknown
>>
Defined in
projects/shapeshift/src/validators/ObjectValidator.ts:21
requiredKeys
• Private
Readonly
requiredKeys: Map
<keyof T
, BaseValidator
<unknown
>>
Defined in
projects/shapeshift/src/validators/ObjectValidator.ts:20
shape
• Readonly
shape: MappedObjectValidator
<T
>
Defined in
projects/shapeshift/src/validators/ObjectValidator.ts:15
strategy
• Readonly
strategy: ObjectValidatorStrategy
Defined in
projects/shapeshift/src/validators/ObjectValidator.ts:16
Accessors
array
• get
array(): ArrayValidator
<T
>
Returns
Inherited from
BaseValidator.array
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:29
ignore
• get
ignore(): this
Returns
this
Defined in
projects/shapeshift/src/validators/ObjectValidator.ts:81
nullable
• get
nullable(): UnionValidator
<null
| T
>
Returns
UnionValidator
<null
| T
>
Inherited from
BaseValidator.nullable
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:21
nullish
• get
nullish(): UnionValidator
<undefined
| null
| T
>
Returns
UnionValidator
<undefined
| null
| T
>
Inherited from
BaseValidator.nullish
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:25
optional
• get
optional(): UnionValidator
<undefined
| T
>
Returns
UnionValidator
<undefined
| T
>
Inherited from
BaseValidator.optional
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:17
partial
• get
partial(): ObjectValidator
<{ [Key in string | number | symbol]?: T[Key] }>
Returns
ObjectValidator
<{ [Key in string | number | symbol]?: T[Key] }>
Defined in
projects/shapeshift/src/validators/ObjectValidator.ts:89
passthrough
• get
passthrough(): this
Returns
this
Defined in
projects/shapeshift/src/validators/ObjectValidator.ts:85
set
• get
set(): SetValidator
<T
>
Returns
SetValidator
<T
>
Inherited from
BaseValidator.set
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:33
strict
• get
strict(): ObjectValidator
<{ [Key in string | number | symbol]-?: T[Key] }>
Returns
ObjectValidator
<{ [Key in string | number | symbol]-?: T[Key] }>
Defined in
projects/shapeshift/src/validators/ObjectValidator.ts:77
Methods
addConstraint
▸ Protected
addConstraint(constraint
): ObjectValidator
<T
>
Parameters
Name | Type |
---|---|
constraint | IConstraint <T , T > |
Returns
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:73
clone
▸ Protected
clone(): ObjectValidator
<T
>
Returns
Overrides
Defined in
projects/shapeshift/src/validators/ObjectValidator.ts:126
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:47
extend
▸ extend<ET
>(schema
): ObjectValidator
<T
& ET
>
Type parameters
Name | Type |
---|---|
ET | extends NonNullObject |
Parameters
Name | Type |
---|---|
schema | ObjectValidator <ET > | MappedObjectValidator <ET > |
Returns
ObjectValidator
<T
& ET
>
Defined in
projects/shapeshift/src/validators/ObjectValidator.ts:94
handle
▸ Protected
handle(value
): Result
<T
, CombinedPropertyError
| ValidationError
>
Parameters
Name | Type |
---|---|
value | unknown |
Returns
Result
<T
, CombinedPropertyError
| ValidationError
>
Overrides
Defined in
projects/shapeshift/src/validators/ObjectValidator.ts:109
handleIgnoreStrategy
▸ Private
handleIgnoreStrategy(value
): Result
<T
, CombinedPropertyError
>
Parameters
Name | Type |
---|---|
value | NonNullObject |
Returns
Result
<T
, CombinedPropertyError
>
Defined in
projects/shapeshift/src/validators/ObjectValidator.ts:130
handlePassthroughStrategy
▸ Private
handlePassthroughStrategy(value
): Result
<T
, CombinedPropertyError
>
Parameters
Name | Type |
---|---|
value | NonNullObject |
Returns
Result
<T
, CombinedPropertyError
>
Defined in
projects/shapeshift/src/validators/ObjectValidator.ts:233
handleStrictStrategy
▸ Private
handleStrictStrategy(value
): Result
<T
, CombinedPropertyError
>
Parameters
Name | Type |
---|---|
value | NonNullObject |
Returns
Result
<T
, CombinedPropertyError
>
Defined in
projects/shapeshift/src/validators/ObjectValidator.ts:186
omit
▸ omit<K
>(keys
): ObjectValidator
<{ [Key in string | number | symbol]: T[Key] }>
Type parameters
Name | Type |
---|---|
K | extends string | number | symbol |
Parameters
Name | Type |
---|---|
keys | readonly K [] |
Returns
ObjectValidator
<{ [Key in string | number | symbol]: T[Key] }>
Defined in
projects/shapeshift/src/validators/ObjectValidator.ts:104
or
▸ or<O
>(...predicates
): UnionValidator
<T
| O
>
Type parameters
Name |
---|
O |
Parameters
Name | Type |
---|---|
...predicates | readonly BaseValidator <O >[] |
Returns
UnionValidator
<T
| O
>
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:37
parse
▸ parse(value
): T
Parameters
Name | Type |
---|---|
value | unknown |
Returns
T
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:63
pick
▸ pick<K
>(keys
): ObjectValidator
<{ [Key in string | number | symbol]: T[Key] }>
Type parameters
Name | Type |
---|---|
K | extends string | number | symbol |
Parameters
Name | Type |
---|---|
keys | readonly K [] |
Returns
ObjectValidator
<{ [Key in string | number | symbol]: T[Key] }>
Defined in
projects/shapeshift/src/validators/ObjectValidator.ts:99
run
▸ run(value
): Result
<T
, BaseError
>
Parameters
Name | Type |
---|---|
value | unknown |
Returns
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:51
transform
▸ transform(cb
): ObjectValidator
<T
>
Parameters
Name | Type |
---|---|
cb | (value : T ) => T |
Returns
Inherited from
Defined in
projects/shapeshift/src/validators/BaseValidator.ts:41
▸ transform<O
>(cb
): BaseValidator
<O
>
Type parameters
Name |
---|
O |
Parameters
Name | Type |
---|---|
cb | (value : T ) => O |