custom

Creates a custom pipeline validation action.

const Validation = custom<TInput>(requirement, message);

Generics

TInput extends string

Parameters

requirement (input: TInput) => boolean
message ErrorMessage | undefined

Explanation

With custom you can freely validate the input and return true if it is valid or false otherwise. If the input does not match your requirement, you can use message to customize the error message.

Returns

Validation CustomValidation<TInput>

Examples

The following examples show how custom can be used.

Custom object schema

Schema to validate a custom object.

const CustomObjectSchema = object(
  {
    list: array(string()),
    length: number(),
  },
  [
    custom(
      (input) => input.list.length === input.length,
      'The list does not match the length.'
    ),
  ]
);

The following APIs can be combined with custom.

Schemas

any,
array,
bigint,
blob,
boolean,
date,
instance,
intersect,
map,
number,
object,
record,
set,
special,
string,
tuple,
union,
unknown,
variant