returnsAsync

Creates a function return transformation action.

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

Generics

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

Parameters

schema TSchema

Explanation

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

Returns

Action ReturnsActionAsync<TInput, TSchema>

Examples

The following examples show how returnsAsync can be used.

Product function schema

Schema of a function that returns a product by its ID.

import { isValidProductId } from '~/api';

const ProductFunctionSchema = v.pipeAsync(
  v.function(),
  v.argsAsync(
    v.tupleAsync([v.pipeAsync(v.string(), v.checkAsync(isValidProductId))])
  ),
  v.returnsAsync(
    v.pipeAsync(
      v.promise(),
      v.awaitAsync(),
      v.object({
        id: v.string(),
        name: v.string(),
        price: v.number(),
      })
    )
  )
);

The following APIs can be combined with returnsAsync.

Schemas

Methods

pipe