Skip to main content
Home
Browse packagesDocsSign in
This release is 1 version behind 1.1.0 — the latest version of @valibot/valibot. Jump to latest

@valibot/valibot@1.0.0
Built and signed on GitHub Actions

fabian-hiller/valibot

The modular and type safe schema library for validating structural data 🤖

This package works with Cloudflare Workers, Node.js, Deno, Bun, Browsers
This package works with Cloudflare Workers
This package works with Node.js
This package works with Deno
This package works with Bun
This package works with Browsers
JSR Score
100%
Published
2 months ago (1.0.0)
Package root>src>actions>args>argsAsync.ts
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119
import type {
  LooseTupleIssue,
  LooseTupleSchema,
  LooseTupleSchemaAsync,
  StrictTupleIssue,
  StrictTupleSchema,
  StrictTupleSchemaAsync,
  TupleIssue,
  TupleSchema,
  TupleSchemaAsync,
  TupleWithRestIssue,
  TupleWithRestSchema,
  TupleWithRestSchemaAsync,
} from '../../schemas/index.ts';
import type {
  BaseIssue,
  BaseSchema,
  BaseSchemaAsync,
  BaseTransformation,
  ErrorMessage,
  InferInput,
  SuccessDataset,
  TupleItems,
  TupleItemsAsync,
} from '../../types/index.ts';
import { ValiError } from '../../utils/index.ts';

/**
 * Schema type.
 */
type Schema =
  | LooseTupleSchema<TupleItems, ErrorMessage<LooseTupleIssue> | undefined>
  | LooseTupleSchemaAsync<
      TupleItemsAsync,
      ErrorMessage<LooseTupleIssue> | undefined
    >
  | StrictTupleSchema<TupleItems, ErrorMessage<StrictTupleIssue> | undefined>
  | StrictTupleSchemaAsync<
      TupleItemsAsync,
      ErrorMessage<StrictTupleIssue> | undefined
    >
  | TupleSchema<TupleItems, ErrorMessage<TupleIssue> | undefined>
  | TupleSchemaAsync<TupleItemsAsync, ErrorMessage<TupleIssue> | undefined>
  | TupleWithRestSchema<
      TupleItems,
      BaseSchema<unknown, unknown, BaseIssue<unknown>>,
      ErrorMessage<TupleWithRestIssue> | undefined
    >
  | TupleWithRestSchemaAsync<
      TupleItemsAsync,
      | BaseSchema<unknown, unknown, BaseIssue<unknown>>
      | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>,
      ErrorMessage<TupleWithRestIssue> | undefined
    >;

/**
 * Args action async type.
 */
export interface ArgsActionAsync<
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
  TInput extends (...args: any[]) => unknown,
  TSchema extends Schema,
> extends BaseTransformation<
    TInput,
    (...args: InferInput<TSchema>) => Promise<Awaited<ReturnType<TInput>>>,
    never
  > {
  /**
   * The action type.
   */
  readonly type: 'args';
  /**
   * The action reference.
   */
  readonly reference: typeof argsAsync;
  /**
   * The arguments schema.
   */
  readonly schema: TSchema;
}

/**
 * Creates a function arguments transformation action.
 *
 * @param schema The arguments schema.
 *
 * @returns An args action.
 */
export function argsAsync<
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
  TInput extends (...args: any[]) => unknown,
  TSchema extends Schema,
>(schema: TSchema): ArgsActionAsync<TInput, TSchema>;

// @__NO_SIDE_EFFECTS__
export function argsAsync(
  schema: Schema
): ArgsActionAsync<(...args: unknown[]) => unknown, Schema> {
  return {
    kind: 'transformation',
    type: 'args',
    reference: argsAsync,
    async: false,
    schema,
    '~run'(dataset, config) {
      const func = dataset.value;
      dataset.value = async (...args) => {
        const argsDataset = await schema['~run']({ value: args }, config);
        if (argsDataset.issues) {
          throw new ValiError(argsDataset.issues);
        }
        return func(...argsDataset.value);
      };
      return dataset as SuccessDataset<
        (...args: unknown[]) => Promise<unknown>
      >;
    },
  };
}