Class: VRecord<Type, Key, Value, IsOptional, FieldPaths>
values.VRecord
The type of the v.record() validator.
Type parameters
| Name | Type |
|---|---|
Type | Type |
Key | extends Validator<string, "required", any> |
Value | extends Validator<any, "required", any> |
IsOptional | extends OptionalProperty = "required" |
FieldPaths | extends string = string |
Hierarchy
-
BaseValidator<Type,IsOptional,FieldPaths>↳
VRecord
Constructors
constructor
• new VRecord<Type, Key, Value, IsOptional, FieldPaths>(«destructured»)
Usually you'd use v.record(key, value) instead.
Type parameters
| Name | Type |
|---|---|
Type | Type |
Key | extends Validator<string, "required", any> |
Value | extends Validator<any, "required", any> |
IsOptional | extends OptionalProperty = "required" |
FieldPaths | extends string = string |
Parameters
| Name | Type |
|---|---|
«destructured» | Object |
› isOptional | IsOptional |
› key | Key |
› value | Value |
Overrides
BaseValidator<Type, IsOptional, FieldPaths>.constructor
Defined in
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
fieldPaths
• Readonly fieldPaths: FieldPaths
Only for TypeScript, if this an Object validator, then this is the TS type of its property names.
Inherited from
BaseValidator.fieldPaths
Defined in
isOptional
• Readonly isOptional: IsOptional
Whether this is an optional Object property value validator.
Inherited from
BaseValidator.isOptional
Defined in
isConvexValidator
• Readonly isConvexValidator: true
Always "true".
Inherited from
BaseValidator.isConvexValidator
Defined in
key
• Readonly key: Key
The validator for the keys of the record.
Defined in
value
• Readonly value: Value
The validator for the values of the record.
Defined in
kind
• Readonly kind: "record"
The kind of validator, "record".
Defined in
Accessors
optional
• get optional(): boolean
Deprecated
- use isOptional instead
Returns
boolean
Inherited from
BaseValidator.optional