parserAsync

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

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

Универсальные типы (Generics)

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

Параметры

• schema TSchema
• config TConfig

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

• parser ParserAsync<TSchema, TConfig>

Примеры

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

import { isEmailPresent } from '~/api';

try {
  const StoredEmailSchema = v.pipeAsync(
    v.string(),
    v.email(),
    v.checkAsync(isEmailPresent, 'The email is not in the database.')
  );
  const storedEmailParser = v.parserAsync(StoredEmailSchema);
  const storedEmail = await storedEmailParser('jane@example.com');

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

Связанные темы

Следующие API могут быть скомбинированы с parserAsync.

Схемы

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

Асинхронные

arrayAsync, customAsync, exactOptionalAsync, fallbackAsync, intersectAsync, lazyAsync, looseObjectAsync, looseTupleAsync, mapAsync, nonNullableAsync, nonNullishAsync, nonOptionalAsync, nullableAsync, nullishAsync, objectAsync, objectWithRestAsync, optionalAsync, partialAsync, pipeAsync, recordAsync, requiredAsync, setAsync, strictObjectAsync, strictTupleAsync, tupleAsync, tupleWithRestAsync, unionAsync, variantAsync