Class: VIdentity<Type, Kind, IsOptional>

values.VIdentity A native source or request identity validator.

​

Type parameters

​

Hierarchy

• BaseValidator<Type, IsOptional> ↳ VIdentity

​

Constructors

​

constructor

• new VIdentity<Type, Kind, IsOptional>(options)

​

Type parameters

​

Parameters

​

Overrides

BaseValidator&lt;Type, IsOptional&gt;.constructor

​

Properties

​

type

• Readonly type: Type Only for TypeScript, the TS type of the JS values validated by this validator.

​

Inherited from

BaseValidator.type

---

​

fieldPaths

• Readonly fieldPaths: never Only for TypeScript, if this an Object validator, then this is the TS type of its property names.

​

Inherited from

BaseValidator.fieldPaths

---

​

isOptional

• Readonly isOptional: IsOptional Whether this is an optional Object property value validator.

​

Inherited from

BaseValidator.isOptional

---

​

isConvexValidator

• Readonly isConvexValidator: true Always "true".

​

Inherited from

BaseValidator.isConvexValidator

---

​

kind

• Readonly kind: Kind

​

Accessors

​

json

• get json(): ValidatorJSON

​

Returns

ValidatorJSON

​

Overrides

BaseValidator.json

​

Methods

​

optional

▸ optional(): VIdentity<Type | undefined, Kind, "optional">

​

Returns

VIdentity<Type | undefined, Kind, "optional">

​

Overrides

BaseValidator.optional

---

​

asOptional

▸ asOptional(): VIdentity<undefined | Type, Kind, "optional">

​

Returns

VIdentity<undefined | Type, Kind, "optional">

​

Overrides

BaseValidator.asOptional