Spec-Zone.ru › Valibot

args

Создает действие преобразования аргументов функции.

const Action = v.args<TInput, TSchema>(schema);

Обобщения

  • TInput extends (...args: any[]) => unknown
  • TSchema extends LooseTupleSchema<TupleItems, ErrorMessage<LooseTupleIssue> | undefined> | StrictTupleSchema<TupleItems, ErrorMessage<StrictTupleIssue> | undefined> | TupleSchema<TupleItems, ErrorMessage<TupleIssue> | undefined> | TupleWithRestSchema<TupleItems, BaseSchema<unknown, unknown, BaseIssue<unknown>>, ErrorMessage<TupleWithRestIssue> | undefined>

Параметры

  • schema TSchema

Пояснение

С помощью args можно задать аргументы функции в соответствии с указанной schema.

Возвращает

  • Action ArgsAction<TInput, TSchema>

Примеры

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

Схема функции

Схема функции, преобразующей строку в число.

const FunctionSchema = v.pipe(
  v.function(),
  v.args(v.tuple([v.pipe(v.string(), v.decimal())])),
  v.returns(v.number())
);

Связанные API

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

Схемы

any, custom, looseTuple, function, strictTuple, tuple, tupleWithRest

Методы

pipe

Утилиты

isOfKind, isOfType

© Fabian Hiller
Licensed under the MIT License.
https://valibot.dev/api/args/

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API