picklist

Создаёт схему picklist.

const Schema = v.picklist<TOptions, TMessage>(options, message);

Дженерики

• TOptions extends PicklistOptions
• TMessage extends ErrorMessage<PicklistIssue> | undefined

Параметры

• options TOptions
• message TMessage

Объяснение

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

picklist работает аналогично enum. Однако во многих случаях его проще использовать, поскольку вы можете передать массив значений вместо перечисления (enum).

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

• Schema PicklistSchema<TOptions, TMessage>

Примеры

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

Схема языка

Схема для валидации языков программирования.

const LanguageSchema = v.picklist(['JavaScript', 'TypeScript']);

Схема страны

Схема для валидации кодов стран.

const countries = [
  { name: 'Germany', code: 'DE' },
  { name: 'France', code: 'FR' },
  { name: 'United States', code: 'US' },
] as const;

const CountrySchema = v.picklist(
  countries.map((country) => country.code),
  'Please select your country.'
);

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

Следующие API могут быть объединены с picklist.

Схемы

array, exactOptional, intersect, lazy, looseObject, looseTuple, map, nonNullable, nonNullish, nonOptional, nullable, nullish, object, objectWithRest, optional, record, set, strictObject, strictTuple, tuple, tupleWithRest, undefinedable, union

Методы

assert, config, fallback, getDefault, getDefaults, getFallback, getFallbacks, is, message, parse, parser, pipe, safeParse, safeParser

Действия

check, brand, description, flavor, guard, metadata, rawCheck, rawTransform, readonly, title, transform

Утилиты

entriesFromList, isOfKind, isOfType