Class: VObjectRef<I, Optional, Type, FieldPaths>

values.VObjectRef An interface reference validator preserves its exact declared domain through optional fields, independently of the ancestors its value may satisfy.

​

Type parameters

​

Constructors

​

constructor

• new VObjectRef<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

---

​

[objectReferenceContract]

• Readonly [objectReferenceContract]: I

---

​

interfaceName

• Readonly interfaceName: I["name"]

---

​

fields

• Readonly fields: ReferenceFields

---

​

isOptional

• Readonly isOptional: Optional

​

Methods

​

optional

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

​

Returns

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