Skip to main content
values.VFileInput An operation input whose value is a staged file.

​
Type parameters

​
Hierarchy

  • VString<Type, IsOptional> ↳ VFileInput

​
Properties

​
fileInput

• Readonly fileInput: Readonly<FileInputDeclaration>

​
type

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

​
Inherited from

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

VString.fieldPaths

​
isOptional

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

​
Inherited from

VString.isOptional

​
isConvexValidator

• Readonly isConvexValidator: true Always "true".

​
Inherited from

VString.isConvexValidator

​
kind

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

​
Inherited from

VString.kind

​
Methods

​
optional

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

​
Returns

VFileInput<undefined | Type, "optional">

​
Overrides

VString.optional

​
asOptional

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

​
Returns

VFileInput<undefined | Type, "optional">

​
Overrides

VString.asOptional