instance

Creates an instance schema.

// Instance schema with an optional pipe
const Schema = instance<TClass>(class_, pipe);

// Instance schema with an optional message and pipe
const Schema = instance<TClass>(class_, message, pipe);

Generics

Parameters

Explanation

With instance you can validate the data type of the input and with pipe you can transform and validate the further details of the instance. 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 = instance(Error, 'Error instance required.');

File schema

Schema to validate an File instance.

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

The following APIs can be combined with instance.

Schemas

Methods

Transformations

Validations

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 ivan-mihalic
  • GitHub profile picture of KATT
  • GitHub profile picture of osdiab
  • GitHub profile picture of Thanaen
  • GitHub profile picture of hyunbinseo
  • GitHub profile picture of caegdeveloper