includes

Creates a pipeline validation action that validates the content of a string or array.

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

Generics

TInput extends string | any[]
TRequirement extends TInput[number] extends any[] ? TInput[number] : TInput

Parameters

requirement TRequirement
message ErrorMessage | undefined

Explanation

With includes you can validate the content of a string or array. If the input does not match the requirement, you can use message to customize the error message.

Returns

Validation IncludesValidation<TInput>

Examples

The following examples show how includes can be used.

String schema

Schema to validate that a string contains a specific substring.

const StringSchema = string([
  includes('foo', 'The string must contain "foo".'),
]);

Array schema

Schema to validate that an array contains a specific string.

const ArraySchema = array(string(), [
  includes('foo', 'The array must contain "foo".'),
]);

The following APIs can be combined with includes.