Skip to main content

Class: VBytes<Type, IsOptional>

values.VBytes

The type of the v.bytes() validator.

Type parameters

NameType
TypeArrayBuffer
IsOptionalextends OptionalProperty = "required"

Hierarchy

  • BaseValidator<Type, IsOptional>

    VBytes

Constructors

constructor

new VBytes<Type, IsOptional>(«destructured»)

Type parameters

NameType
TypeArrayBuffer
IsOptionalextends OptionalProperty = "required"

Parameters

NameType
«destructured»Object
› isOptionalIsOptional

Inherited from

BaseValidator<Type, IsOptional>.constructor

Defined in

values/validators.ts:38

Properties

type

Readonly type: Type

Only for TypeScript, the TS type of the JS values validated by this validator.

Inherited from

BaseValidator.type

Defined in

values/validators.ts:21


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

Defined in

values/validators.ts:26


isOptional

Readonly isOptional: IsOptional

Whether this is an optional Object property value validator.

Inherited from

BaseValidator.isOptional

Defined in

values/validators.ts:31


isConvexValidator

Readonly isConvexValidator: true

Always "true".

Inherited from

BaseValidator.isConvexValidator

Defined in

values/validators.ts:36


kind

Readonly kind: "bytes"

The kind of validator, "bytes".

Defined in

values/validators.ts:177

Accessors

optional

get optional(): boolean

Deprecated

  • use isOptional instead

Returns

boolean

Inherited from

BaseValidator.optional

Defined in

values/validators.ts:43