Type parameters
Hierarchy
-
BaseValidator<Type,IsOptional,FieldPaths> ↳VDerived
Constructors
constructor
• new VDerived<Type, IsOptional, FieldPaths>(expression, resolve, isOptional)
Type parameters
Parameters
Overrides
BaseValidator<Type, IsOptional, FieldPaths>.constructorProperties
type
•Readonly type: Type
Only for TypeScript, the TS type of the JS values validated
by this validator.
Inherited from
BaseValidator.typefieldPaths
•Readonly fieldPaths: FieldPaths
Only for TypeScript, if this an Object validator, then
this is the TS type of its property names.
Inherited from
BaseValidator.fieldPathsisOptional
•Readonly isOptional: IsOptional
Whether this is an optional Object property value validator.
Inherited from
BaseValidator.isOptionalisConvexValidator
•Readonly isConvexValidator: true
Always "true".
Inherited from
BaseValidator.isConvexValidatorkind
•Readonly kind: "derived"
Accessors
json
•get json(): ValidatorJSON
Returns
ValidatorJSON
Overrides
BaseValidator.jsonMethods
optional
▸ optional():VDerived<Type | undefined, "optional", FieldPaths>
Returns
VDerived<Type | undefined, "optional", FieldPaths>
Overrides
BaseValidator.optionalasOptional
▸ asOptional():VDerived<undefined | Type, "optional", FieldPaths>
Returns
VDerived<undefined | Type, "optional", FieldPaths>
Overrides
BaseValidator.asOptionalrequired
▸ required():VDerived<Exclude<Type, undefined>, "required", FieldPaths>
Preserve the original lazy signature and its refinements when requiring
a projected value. Neither authoring nor runtime resolution happens here.
Returns
VDerived<Exclude<Type, undefined>, "required", FieldPaths>