returns

Creates a function return transformation action.

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

Generics

With returns you can force the returned value of a function to match the given schema.

The following examples show how returns can be used.

Schema of a function that transforms a string to a number.

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

The following APIs can be combined with returns.