safeParser

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

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

Обобщения

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

Параметры

• schema TSchema
• config TConfig

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

• safeParser SafeParser<TSchema, TConfig>

Пример

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

const EmailSchema = v.pipe(v.string(), v.email());
const safeEmailParser = v.safeParser(EmailSchema);
const result = safeEmailParser('jane@example.com');

if (result.success) {
  const email = result.output;
} else {
  console.log(result.issues);
}

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

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

Схемы

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