> ## 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: VRecord<Type, Key, Value, IsOptional, FieldPaths>

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

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

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

## Type parameters

| Name | Type |
| :- | :- |
| `Type` | `Type` |
| `Key` | extends [`Validator`](/api/modules/values#validator)\<`string`, `"required"`, `any`> |
| `Value` | extends [`Validator`](/api/modules/values#validator)\<`any`, `"required"`, `any`> |
| `IsOptional` | extends [`OptionalProperty`](/api/modules/values#optionalproperty) = `"required"` |
| `FieldPaths` | extends `string` = `string` |

## Hierarchy

* `BaseValidator`\<`Type`, `IsOptional`, `FieldPaths`>

  ↳ **`VRecord`**

## Constructors

### constructor

• **new VRecord**\<`Type`, `Key`, `Value`, `IsOptional`, `FieldPaths`>(`«destructured»`)

Usually you'd use `v.record(key, value)` instead.

#### Type parameters

| Name | Type |
| :- | :- |
| `Type` | `Type` |
| `Key` | extends [`Validator`](/api/modules/values#validator)\<`string`, `"required"`, `any`> |
| `Value` | extends [`Validator`](/api/modules/values#validator)\<`any`, `"required"`, `any`> |
| `IsOptional` | extends [`OptionalProperty`](/api/modules/values#optionalproperty) = `"required"` |
| `FieldPaths` | extends `string` = `string` |

#### Parameters

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

#### Overrides

BaseValidator\&lt;Type, IsOptional, FieldPaths\&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**: `FieldPaths`

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

***

### key

• `Readonly` **key**: `Key`

The validator for the keys of the record.

***

### value

• `Readonly` **value**: `Value`

The validator for the values of the record.

***

### kind

• `Readonly` **kind**: `"record"`

The kind of validator, `"record"`.

## Methods

### optional

▸ **optional**(): [`VRecord`](/api/classes/values.VRecord)\<`undefined` | `Type`, `Key`, `Value`, `"optional"`, `FieldPaths`>

Allow this validated field to be absent.

#### Returns

[`VRecord`](/api/classes/values.VRecord)\<`undefined` | `Type`, `Key`, `Value`, `"optional"`, `FieldPaths`>

#### Overrides

BaseValidator.optional