Skip to main content
server.VUpload An operation-only string validator carrying its upload meaning.

Type parameters

Hierarchy

  • VString<Type, IsOptional> ↳ VUpload

Constructors

constructor

• new VUpload<Type, IsOptional>(options, isOptional)

Type parameters

Parameters

Overrides

VString.constructor

Properties

upload

• Readonly upload: Readonly<UploadOptions>

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(): VUpload<undefined | Type, "optional"> Allow this validated field to be absent.

Returns

VUpload<undefined | Type, "optional">

Overrides

VString.optional

asOptional

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

Returns

VUpload<undefined | Type, "optional">

Overrides

VString.asOptional