Class: VLiteral<Type, IsOptional>

values.VLiteral The type of the v.literal() validator.

​

Type parameters

​

Hierarchy

• BaseValidator<Type, IsOptional> ↳ VLiteral

​

Constructors

​

constructor

• new VLiteral<Type, IsOptional>(«destructured») Usually you’d use v.literal(value) instead.

​

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

---

​

isBijectionValidator

• Readonly isBijectionValidator: true Always "true".

​

Inherited from

BaseValidator.isBijectionValidator

---

​

value

• Readonly value: Type The value that the validated values must be equal to.

---

​

kind

• Readonly kind: "literal" The kind of validator, "literal".

​

Methods

​

optional

▸ optional(): VLiteral<undefined | Type, "optional"> Allow this validated field to be absent.

​

Returns

VLiteral<undefined | Type, "optional">

​

Overrides

BaseValidator.optional