forward

Forwards the issues of the passed validation action.

const Validation = forward<TInput>(validation, pathList);

Generics

• TInput extends unknown[] | Record<unknown>

Parameters

• validation BaseValidation<TInput>
• pathList PathList<TInput>

Explanation

forward allows you to forward the issues of the passed validation action via a pathList to a nested field of a schema.

Returns

• Validation BaseValidation<TInput>

Examples

The following examples show how forward can be used.

Password schema

Schema that ensures that the two passwords match.

const PasswordSchema = object(
  {
    password1: string([
      minLength(1, 'Please enter your password.'),
      minLength(8, 'Your password must have 8 characters or more.'),
    ]),
    password2: string(),
  },
  [
    forward(
      custom(
        (input) => input.password1 === input.password2,
        'The two passwords do not match.'
      ),
      ['password2']
    ),
  ]
);

Related

The following APIs can be combined with forward.

Schemas

• any,
• array,
• object,
• record,
• special,
• tuple,
• union,
• unknown,
• variant

Methods

• merge,
• omit,
• partial,
• pick,
• required,
• transform

Validations

• custom,
• every,
• excludes,
• includes,
• length,
• maxLength,
• minLength,
• notLength,
• some