Skip to main content
values.VCollectionRef

Type parameters

Constructors

constructor

• new VCollectionRef<I, Optional, Type, FieldPaths>(contract, isOptional)

Type parameters

Parameters

Properties

kind

• Readonly kind: "object"

isConvexValidator

• Readonly isConvexValidator: true

type

• Readonly type: Type

fieldPaths

• Readonly fieldPaths: FieldPaths

interfaceName

• Readonly interfaceName: I["name"]

fields

• Readonly fields: Object

Type declaration


isOptional

• Readonly isOptional: Optional

Accessors

json

• get json(): ValidatorJSON

Returns

ValidatorJSON

Methods

optional

▸ optional(): VCollectionRef<I, "optional", Type | undefined, FieldPaths>

Returns

VCollectionRef<I, "optional", Type | undefined, FieldPaths>

asOptional

▸ asOptional(): VCollectionRef<I, "optional", Type | undefined, FieldPaths>

Returns

VCollectionRef<I, "optional", Type | undefined, FieldPaths>