> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bijection.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Class: VLiteral<Type, IsOptional>

> The type of the v.literal() validator.

[values](/api/modules/values).VLiteral

The type of the `v.literal()` validator.

## Type parameters

| Name | Type |
| :- | :- |
| `Type` | `Type` |
| `IsOptional` | extends [`OptionalProperty`](/api/modules/values#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`](/api/modules/values#optionalproperty) = `"required"` |

#### Parameters

| Name | Type |
| :- | :- |
| `«destructured»` | `Object` |
| › `isOptional` | `IsOptional` |
| › `value` | `Type` |

#### 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`](/api/classes/values.VLiteral)\<`undefined` | `Type`, `"optional"`>

Allow this validated field to be absent.

#### Returns

[`VLiteral`](/api/classes/values.VLiteral)\<`undefined` | `Type`, `"optional"`>

#### Overrides

BaseValidator.optional