assert

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

Поскольку это функция-утверждение, её можно использовать в качестве защиты типа.

v.assert<TSchema>(schema, input);

Обобщения

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

Параметры

• schema TSchema
• input unknown

Пояснение

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

Пример

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

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

v.assert(EmailSchema, data);
const email = data; // string

Связанные материалы

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

Схемы

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