> ## 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: VId<Type, IsOptional>

> The type of the v.id(tableName) validator.

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

The type of the `v.id(tableName)` validator.

## Type parameters

| Name | Type |
| :- | :- |
| `Type` | `Type` |
| `IsOptional` | extends [`OptionalProperty`](/api/modules/values#optionalproperty) = `"required"` |

## Hierarchy

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

  ↳ **`VId`**

## Constructors

### constructor

• **new VId**\<`Type`, `IsOptional`>(`«destructured»`)

Usually you'd use `v.id(tableName)` instead.

#### Type parameters

| Name | Type |
| :- | :- |
| `Type` | `Type` |
| `IsOptional` | extends [`OptionalProperty`](/api/modules/values#optionalproperty) = `"required"` |

#### Parameters

| Name | Type |
| :- | :- |
| `«destructured»` | `Object` |
| › `isOptional` | `IsOptional` |
| › `tableName` | `TableNameFromType`\<`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

***

### tableName

• `Readonly` **tableName**: `TableNameFromType`\<`Type`>

The name of the table that the validated IDs must belong to.

***

### kind

• `Readonly` **kind**: `"id"`

The kind of validator, `"id"`.

## Methods

### optional

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

Allow this field to be validated as absent.

#### Returns

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

#### Overrides

BaseValidator.optional