instance

Создаёт схему экземпляра.

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

Дженерики

• TClass extends Class
• TMessage extends ErrorMessage<InstanceIssue> | undefined

Параметры

• class_ TClass
• message TMessage

Объяснение

С помощью instance вы можете валидировать тип входных данных. Если входные данные не являются экземпляром указанного class_, вы можете использовать message для настройки сообщения об ошибке.

Возвращаемое значение

• Schema InstanceSchema<TClass, TMessage>

Примеры

Следующие примеры показывают, как можно использовать instance.

Схема Error

Схема для валидации экземпляра Error.

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

Схема File

Схема для валидации экземпляра File.

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

Связанные элементы

Следующие API могут использоваться в сочетании с instance.

Схемы

array, exactOptional, intersect, lazy, looseObject, looseTuple, map, nonNullable, nonNullish, nonOptional, nullable, nullish, object, objectWithRest, optional, record, set, strictObject, strictTuple, tuple, tupleWithRest, undefinedable, union

Методы

assert, config, fallback, getDefault, getDefaults, getFallback, getFallbacks, is, message, parse, parser, pipe, safeParse, safeParser

Действия

check, brand, description, flavor, gtValue, ltValue, maxSize, maxValue, metadata, mimeType, minSize, minValue, notSize, notValue, notValues, rawCheck, rawTransform, readonly, size, title, toMaxValue, toMinValue, transform, value, values

Утилиты

entriesFromList, isOfKind, isOfType