Class: VLiteral<Type, IsOptional>
values.VLiteral
The type of the v.literal() validator.
Type parameters
| Name | Type |
|---|---|
Type | Type |
IsOptional | extends OptionalProperty = "required" |
Hierarchy
-
BaseValidator<Type,IsOptional>↳
VLiteral
Constructors
constructor
• new VLiteral<Type, IsOptional>(«destructured»)
Usually you'd use v.literal(value) instead.
Type parameters
| Name | Type |
|---|---|
Type | Type |
IsOptional | extends OptionalProperty = "required" |
Parameters
| Name | Type |
|---|---|
«destructured» | Object |
› isOptional | IsOptional |
› value | Type |
Overrides
BaseValidator<Type, IsOptional>.constructor
Defined in
Properties
type
• Readonly type: Type
Only for TypeScript, the TS type of the JS values validated by this validator.
Inherited from
BaseValidator.type
Defined in
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
Defined in
isOptional
• Readonly isOptional: IsOptional
Whether this is an optional Object property value validator.
Inherited from
BaseValidator.isOptional
Defined in
isConvexValidator
• Readonly isConvexValidator: true
Always "true".
Inherited from
BaseValidator.isConvexValidator
Defined in
value
• Readonly value: Type
The value that the validated values must be equal to.
Defined in
kind
• Readonly kind: "literal"
The kind of validator, "literal".
Defined in
Accessors
optional
• get optional(): boolean
Deprecated
- use isOptional instead
Returns
boolean
Inherited from
BaseValidator.optional