Class: VCommandCall<C, O>

values.VCommandCall A command association remains an ordinary string on the wire.

​

Type parameters

​

Hierarchy

• VString<CommandCallReference<C> | O extends "optional" ? undefined : never, O> ↳ VCommandCall

​

Constructors

​

constructor

• new VCommandCall<C, O>(command, isOptional)

​

Type parameters

​

Parameters

​

Overrides

VString.constructor

​

Properties

​

[commandCallMetadata]

• Readonly [commandCallMetadata]: true

---

​

command

• Readonly command: C

---

​

type

• Readonly type: CommandCallReference<C> | O extends "optional" ? undefined : never 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: O 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(): VCommandCall<C, "optional"> Allow this validated field to be absent.

​

Returns

VCommandCall<C, "optional">

​

Overrides

VString.optional

---

​

asOptional

▸ asOptional(): VCommandCall<C, "optional">

​

Returns

VCommandCall<C, "optional">

​

Overrides

VString.asOptional