parse

Разбирает неизвестный вход на основе схемы.

const output = v.parse<TSchema>(schema, input, config);

Обобщения

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

Параметры

• schema TSchema
• input unknown
• config Config<InferIssue<TSchema>> | undefined

Пояснение

parse вызовет ValiError, если input не соответствует schema. Поэтому следует использовать блок try/catch для перехвата ошибок. Если входные данные соответствуют схеме, они считаются допустимыми, и типизированное output схемы будет возвращено.

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

• output InferOutput<TSchema>

Пример

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

try {
  const EmailSchema = v.pipe(v.string(), v.email());
  const email = v.parse(EmailSchema, 'jane@example.com');

  // Handle errors if one occurs
} catch (error) {
  console.log(error);
}

Связанные API

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

Схемы

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, flatten, keyof, message, omit, partial, pick, pipe, required, summarize, unwrap

Вспомогательные средства

getDotPath, isValiError, ValiError