Record type

The record type is similar to the object type. However, you may use it to validate objects with unknown keys.

In the following example, we want to accept an object of colors. The object keys can be anything. However, the values should be a valid hex code.

import vine from '@vinejs/vine'

const schema = vine.object({
  colors: vine.record(
    vine.string().hexCode()
  )
})

const data = {
  colors: {
    white: '#ffffff',
    black: '#000000',
    lime: '#99d52a'
  }
}

const validate = vine.compile(schema)
const output = await validate(data)

Using the following modifiers, you may mark the record as optional or nullable.

{
  colors: vine.record(
    vine.string().hexCode()
  ).nullable()
}

{
  colors: vine.record(
    vine.string().hexCode()
  ).optional()
}

Creating a record of unions

Since the record type accepts any valid VineJS type, you may also use the union type with it.

In the following example, we want the value of each key to be either a hex code or a nested object with a color scale. For example:

The clone method creates a new instance from an existing schema type. It is a great way to create a base type and then clone it for further modifications.

const color = vine.string().hexCode()

const scale = vine.object({
  '1': color.clone(),
  '2': color.clone(),
  '3': color.clone(),
  '4': color.clone(),
  '5': color.clone(),
  '6': color.clone(),
  '7': color.clone(),
  '8': color.clone(),
  '9': color.clone(),
  '10': color.clone(),
  '11': color.clone(),
})

{
  colors: vine.record(
    vine.unionOfTypes([color, scale])
  )
}

Defining error messages

You may define custom error messages for the following record based rules.

const messages = {
  'record': 'The {{ field }} field must be an object',
  'record.minLength': 'The {{ field }} field must have at least {{ min }} items',
  'record.maxLength': 'The {{ field }} field must not have more than {{ max }} items',
  'record.fixedLength': 'The {{ field }} field must contain {{ size }} items'
}

vine.messagesProvider = new SimpleMessagesProvider(messages)

Validations

Following are the validation rules you can apply to a record schema type.

minLength

Enforce the object keys to have the expected minimum length.

{
  colors: vine.record(
    vine.string().hexCode()
  ).minLength(1)
}

maxLength

Enforce the object keys to have the expected maximum length.

{
  colors: vine.record(
    vine.string().hexCode()
  ).maxLength(11)
}

fixedLength

Enforce the object keys to have a fixed length.

{
  colors: vine.record(
    vine.string().hexCode()
  ).fixedLength(11)
}

validateKeys

The validateKeys method allows you to perform custom validation on the object keys by defining a callback. The callback receives an array of keys as the first argument and the field context as the second argument.

{
  colors: vine
    .record(vine.string().hexCode())
    .validateKeys((keys, field) => {
      const nonNumericKey = keys.find((key) => !vine.helpers.isNumber(key))

      if (!!nonNumericKey) {
        field.report(
          'Color scale must be a valid number', // message
          'record.keys.number', // error id
          field
        )
      }
    })
}