safeParse

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

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

Параметры обобщённого типа

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

Параметры

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

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

• result SafeParseResult<TSchema>

Пример

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

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

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

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

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

Схемы

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