setAsync

Создает схему множества.

const Schema = v.setAsync<TValue, TMessage>(value, message);

Дженерики

• TValue extends BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>
• TMessage extends ErrorMessage<SetIssue> | undefined

Параметры

• value TValue
• message TMessage

Пояснение

С помощью setAsync вы можете проверить тип данных входного значения и соответствие содержимого value. Если входное значение не является множеством, вы можете использовать message для настройки сообщения об ошибке.

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

• Schema SetSchemaAsync<TValue, TMessage>

Примеры

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

Схема разрешенных IP-адресов

Схема для валидации множества разрешенных IP-адресов.

import { isIpAllowed } from '~/api';

const AllowedIPsSchema = v.setAsync(
  v.pipeAsync(
    v.string(),
    v.ip(),
    v.checkAsync(isIpAllowed, 'This IP address is not allowed.')
  )
);

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

Следующие API можно объединять с setAsync.

Схемы

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, strictObject, strictTuple, string, symbol, tuple, tupleWithRest, undefined, undefinedable, union, unknown, variant, void

Методы

config, getDefault, getFallback

Действия

brand, check, description, flavor, guard, maxSize, metadata, minSize, notSize, rawCheck, rawTransform, readonly, size, title, transform

Утилиты

entriesFromList, isOfKind, isOfType

Асинхронные

arrayAsync, checkAsync, customAsync, exactOptionalAsync, fallbackAsync, getDefaultsAsync, getFallbacksAsync, intersectAsync, lazyAsync, looseObjectAsync, looseTupleAsync, mapAsync, nonNullableAsync, nonNullishAsync, nonOptionalAsync, nullableAsync, nullishAsync, objectAsync, objectWithRestAsync, optionalAsync, parseAsync, parserAsync, pipeAsync, rawCheckAsync, rawTransformAsync, recordAsync, safeParseAsync, safeParserAsync, strictObjectAsync, strictTupleAsync, transformAsync, tupleAsync, tupleWithRestAsync, unionAsync, variantAsync