returns

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

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

Обобщения

• TInput extends (...args: any[]) => unknown
• TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>>

Параметры

• schema TSchema

Пояснение

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

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

• Action ReturnsAction<TInput, TSchema>

Примеры

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

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

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

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

Связанные API

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

Схемы

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

Методы

pipe

Утилиты

isOfKind, isOfType