Skip to main content
server.VFile Not exported: an exported type refers to it.

​
Type parameters

​
Hierarchy

  • VId<Type, IsOptional> ↳ VFile

​
Constructors

​
constructor

• new VFile<Type, IsOptional>(isOptional)

​
Type parameters

​
Parameters

​
Overrides

VId.constructor

​
Properties

​
fileReference

• Readonly fileReference: true

​
type

• Readonly type: Type Only for TypeScript, the TS type of the JS values validated by this validator.

​
Inherited from

VId.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

VId.fieldPaths

​
isOptional

• Readonly isOptional: IsOptional Whether this is an optional Object property value validator.

​
Inherited from

VId.isOptional

​
isConvexValidator

• Readonly isConvexValidator: true Always "true".

​
Inherited from

VId.isConvexValidator

​
tableName

• Readonly tableName: TableNameFromType<Type> The name of the table that the validated IDs must belong to.

​
Inherited from

VId.tableName

​
kind

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

​
Inherited from

VId.kind

​
Accessors

​
json

• get json(): ValidatorJSON

​
Returns

ValidatorJSON

​
Inherited from

VId.json

​
Methods

​
optional

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

​
Returns

VFile<undefined | Type, "optional">

​
Overrides

VId.optional

​
asOptional

▸ asOptional(): VFile<undefined | Type, "optional">

​
Returns

VFile<undefined | Type, "optional">

​
Overrides

VId.asOptional