Class VineRecord<Schema>

VineRecord represents an object with dynamic keys where all values share the same schema. Unlike VineObject which has predefined properties, records allow any string key but enforce consistent value types across all keys.

Example

const schema = vine.record(vine.number())

const result = await vine.validate({
  schema,
  data: { a: 1, b: 2, c: 3 }
})

Example

// Record with complex value types
const schema = vine.record(
  vine.object({
    name: vine.string(),
    age: vine.number()
  })
)

Type Parameters

Schema extends SchemaTypes
The schema type for validating all record values

Hierarchy (View Summary)

BaseType<
    { [K: string]: Schema[typeof ITYPE] },
    { [K: string]: Schema[typeof OTYPE] },
    { [K: string]: Schema[typeof COTYPE] },
>
- VineRecord

Implements

WithJSONSchema

Index

Constructors

constructor

new VineRecord<Schema extends SchemaTypes>(
    schema: Schema,
    options?: FieldOptions,
    validations?: Validation<any>[],
): VineRecord<Schema>
Creates a new VineRecord instance with value schema and optional configuration.
Type Parameters
- Schema extends SchemaTypes
  The schema type for validating all record values
Parameters
- schema: Schema
  The schema to validate each record value
- Optionaloptions: FieldOptions
  Field options like bail mode and nullability
- Optionalvalidations: Validation<any>[]
  Initial set of validations to apply
Returns VineRecord<Schema>
Overrides BaseType.constructor
- Defined in src/schema/record/main.ts:102

Properties

[ITYPE]

"[ITYPE]": { [K: string]: Schema[typeof ITYPE] }

Define the input type of the schema for TypeScript inference

[OTYPE]

"[OTYPE]": { [K: string]: Schema[typeof OTYPE] }

The output value type of the field after validation. The property points to a type only and not the real value.

[COTYPE]

"[COTYPE]": { [K: string]: Schema[typeof COTYPE] }

Type marker for camelCase output type inference

`Static`rules

rules: {
    maxLength: (
        ...options: [options: { max: number }],
    ) => Validation<{ max: number }>;
    minLength: (
        ...options: [options: { min: number }],
    ) => Validation<{ min: number }>;
    fixedLength: (
        ...options: [options: { size: number }],
    ) => Validation<{ size: number }>;
    validateKeys: (
        ...options: [options: (keys: string[], field: FieldContext) => void],
    ) => Validation<(keys: string[], field: FieldContext) => void>;
} = ...

Static collection of all available validation rules for records

[UNIQUE_NAME]

"[UNIQUE_NAME]": string = 'vine.object'

Unique name identifier for union type resolution

Methods

parse

parse(callback: ParseFn): this
Define a method to parse the input value. The method is invoked before any validation and hence you must perform type-checking to know the value you are working with.
Parameters
- callback: ParseFn
  Parser function to transform the input value
Returns this
This schema instance for method chaining
Example
```
vine.string().parse((value) => {
  return typeof value === 'string' ? value.trim() : value
})
```
Inherited from BaseType.parse
- Defined in src/schema/base/main.ts:511

use

use(validation: Validation<any> | RuleBuilder): this
Push a validation to the validations chain.
Parameters
- validation: Validation<any> | RuleBuilder
  Validation rule or rule builder to add
Returns this
This schema instance for method chaining
Example
```
vine.string().use(vine.createRule((value) => {
  return value.length > 0
}))
```
Inherited from BaseType.use
- Defined in src/schema/base/main.ts:527

bail

bail(state: boolean): VineRecord<Schema>
Enable/disable the bail mode. In bail mode, the field validations are stopped after the first error.
Parameters
- state: boolean
  Whether to enable bail mode
Returns VineRecord<Schema>
This schema instance for method chaining
Inherited from BaseType.bail
- Defined in src/schema/base/main.ts:539

optional

optional(): OptionalModifier<VineRecord<Schema>>
Mark the field under validation as optional. An optional field allows both null and undefined values.

Returns OptionalModifier<VineRecord<Schema>>
A new OptionalModifier wrapping this schema
Inherited from BaseType.optional
- Defined in src/schema/base/main.ts:550

nullable

nullable(): NullableModifier<VineRecord<Schema>>
Mark the field under validation to be null. The null value will be written to the output as well.

If optional and nullable are used together, then both undefined and null values will be allowed.

Returns NullableModifier<VineRecord<Schema>>
A new NullableModifier wrapping this schema
Inherited from BaseType.nullable
- Defined in src/schema/base/main.ts:563

[IS_OF_TYPE]

"[IS_OF_TYPE]"(value: unknown): boolean
Type checker function to determine if a value is an object. Required for "unionOfTypes" functionality.
Parameters
- value: unknown
  The value to check
Returns boolean
True if the value is a non-null object and not an array
- Defined in src/schema/record/main.ts:91

minLength

minLength(expectedLength: number): VineRecord<Schema>
Enforce a minimum number of properties on the record.
Parameters
- expectedLength: number
  The minimum required number of key-value pairs
Returns VineRecord<Schema>
This record schema instance for method chaining
- Defined in src/schema/record/main.ts:113

maxLength

maxLength(expectedLength: number): VineRecord<Schema>
Enforce a maximum number of properties on the record.
Parameters
- expectedLength: number
  The maximum allowed number of key-value pairs
Returns VineRecord<Schema>
This record schema instance for method chaining
- Defined in src/schema/record/main.ts:123

fixedLength

fixedLength(expectedLength: number): VineRecord<Schema>
Enforce an exact number of properties on the record.
Parameters
- expectedLength: number
  The exact required number of key-value pairs
Returns VineRecord<Schema>
This record schema instance for method chaining
- Defined in src/schema/record/main.ts:133

validateKeys

validateKeys(
...args: [options: (keys: string[], field: FieldContext) => void],
): VineRecord<Schema>
Register a custom callback to validate the record's keys. Useful for enforcing key naming patterns or checking key existence.
Parameters
- ...args: [options: (keys: string[], field: FieldContext) => void]
  Arguments to pass to the validateKeys rule
Returns VineRecord<Schema>
This record schema instance for method chaining
Example
```
vine.record(vine.string()).validateKeys((keys, field) => {
  if (!keys.every(key => /^[a-z_]+$/.test(key))) {
    field.report('Keys must be lowercase with underscores', 'invalidKeys', field)
  }
})
```
- Defined in src/schema/record/main.ts:151

clone

clone(): this
Clones the VineRecord schema including the value schema, options, and validations.

Returns this
A cloned instance of this VineRecord schema
Overrides BaseType.clone
- Defined in src/schema/record/main.ts:160

toJSONSchema

toJSONSchema(): { type: "object"; additionalProperties: {} }
Converts the record schema to JSON Schema format.

Returns { type: "object"; additionalProperties: {} }
JSON Schema representation of this record
Implementation of WithJSONSchema.toJSONSchema
Overrides BaseType.toJSONSchema
- Defined in src/schema/record/main.ts:173

[PARSE]

"[PARSE]"(
    propertyName: string,
    refs: RefsStore,
    options: ParserOptions,
): RecordNode
Compiles the record schema to a compiler node for validation.
Parameters
- propertyName: string
  Name of the property being compiled
- refs: RefsStore
  Reference store for the compiler
- options: ParserOptions
  Parser options
Returns RecordNode
Compiled record node for validation
Overrides BaseType.[PARSE]
- Defined in src/schema/record/main.ts:197

Class VineRecord<Schema>

Example

Example

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns VineRecord<Schema>

Properties

[ITYPE]

[OTYPE]

[COTYPE]

Staticrules

[UNIQUE_NAME]

Methods

parse

Parameters

Returns this

Example

use

Parameters

Returns this

Example

bail

Parameters

Returns VineRecord<Schema>

optional

Returns OptionalModifier<VineRecord<Schema>>

nullable

Returns NullableModifier<VineRecord<Schema>>

meta

Parameters

Returns MetaModifier<VineRecord<Schema>>

[IS_OF_TYPE]

Parameters

Returns boolean

minLength

Parameters

Returns VineRecord<Schema>

maxLength

Parameters

Returns VineRecord<Schema>

fixedLength

Parameters

Returns VineRecord<Schema>

validateKeys

Parameters

Returns VineRecord<Schema>

Example

clone

Returns this

toJSONSchema

Returns { type: "object"; additionalProperties: {} }

[PARSE]

Parameters

Returns RecordNode

Settings

On This Page

`Static`rules