is

Проверяет, соответствует ли входное значение схеме.

Благодаря предикату типа эту функцию можно использовать в качестве защиты типа.

const result = v.is<TSchema>(schema, input);

Обобщения

• TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>>

Параметры

• schema TSchema
• input unknown

Пояснение

is не изменяет input. Поэтому преобразования не оказывают эффекта, а неизвестные ключи объекта не удаляются. Именно поэтому этот подход не так безопасен и эффективен, как parse и safeParse.

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

• result boolean

Пример

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

const EmailSchema = v.pipe(v.string(), v.email());
const data: unknown = 'jane@example.com';

if (v.is(EmailSchema, data)) {
  const email = data; // string
}

Связанные API

Следующие API можно использовать вместе с is.

Схемы

any, array, bigint, blob, boolean, custom, date, enum, exactOptional, file, function, instance, intersect, lazy, literal, looseObject, looseTuple, map, nan, never, nonNullable, nonNullish, nonOptional, null, nullable, nullish, number, object, objectWithRest, optional, picklist, promise, record, set, strictObject, strictTuple, string, symbol, tuple, tupleWithRest, undefined, undefinedable, union, unknown, variant, void

Методы

assert, config, fallback, keyof, message, omit, partial, pick, pipe, required, unwrap