Spec-Zone.ru › Valibot

parser

Возвращает функцию, которая анализирует неизвестный входной объект на основе схемы.

const parser = v.parser<TSchema, TConfig>(schema, config);

Обобщения

  • TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>>
  • TConfig extends Config<InferIssue<TSchema>> | undefined

Параметры

  • schema TSchema
  • config TConfig

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

  • parser Parser<TSchema, TConfig>

Пример

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

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

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

Связанные API

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

Схемы

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

© Fabian Hiller
Licensed under the MIT License.
https://valibot.dev/api/parser/

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API