excludes

Creates an excludes validation action.

const Action = excludes<TInput, TRequirement, TMessage>(requirement, message);

Generics

Parameters

  • requirement TRequirement
  • message TMessage

Explanation

With excludes 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

Examples

The following examples show how excludes can be used.

String schema

Schema to validate that a string does not contain a specific substring.

const StringSchema = v.pipe(
  v.string(),
  v.excludes('foo', 'The string must not contain "foo".')
);

Array schema

Schema to validate that an array does not contain a specific string.

const ArraySchema = v.pipe(
  v.array(v.string()),
  v.excludes('foo', 'The array must not contain "foo".')
);

The following APIs can be combined with excludes.

Schemas

Methods

Contributors

Thanks to all the contributors who helped make this page better!

  • GitHub profile picture of fabian-hiller

Partners

Thanks to our partners who support the project ideally and financially.

Sponsors

Thanks to our GitHub sponsors who support the project financially.

  • GitHub profile picture of dailydotdev
  • GitHub profile picture of KATT
  • GitHub profile picture of osdiab
  • GitHub profile picture of Thanaen
  • GitHub profile picture of ruiaraujo012
  • GitHub profile picture of hyunbinseo
  • GitHub profile picture of caegdeveloper
  • GitHub profile picture of seahindeniz