instance

Creates an instance schema.

const Schema = instance<TClass, TMessage>(class_, message);

Generics

Parameters

  • class_ TClass
  • message TMessage

Explanation

With instance you can validate the data type of the input. If the input is not an instance of the specified class_, you can use message to customize the error message.

Returns

Examples

The following examples show how instance can be used.

Error schema

Schema to validate an Error instance.

const ErrorSchema = v.instance(Error, 'Error instance required.');

File schema

Schema to validate an File instance.

const FileSchema = v.pipe(
  v.instance(File),
  v.mimeType(['image/jpeg', 'image/png']),
  v.maxSize(1024 * 1024 * 10)
);

The following APIs can be combined with instance.

Schemas

Methods

Actions

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