Giter VIP home page Giter VIP logo

Comments (6)

fabian-hiller avatar fabian-hiller commented on May 26, 2024 1

Thank you for creating this issue! This issue is related to discussion #376.

Do you have an alternative name idea for input?

from valibot.

dboune avatar dboune commented on May 26, 2024 1

input tracks with both Input and at least the motivation for one use case, and here are some other options.

input
inputType
type_
accept
acceptInput
acceptType
allow
allowInput
allowType

from valibot.

fabian-hiller avatar fabian-hiller commented on May 26, 2024 1

Yes, that is correct. Thanks for the research! For now, I prefer to wait for feedback from other developers on this issue.

from valibot.

fabian-hiller avatar fabian-hiller commented on May 26, 2024 1

I think that this is now possible using our new pipe function:

import * as v from 'valibot';

const Schema1 = v.picklist(['foo', 'bar']);
const Schema2 = v.pipe(v.nullable(Schema1), Schema1);

type Input = v.InferInput<typeof Schema2>; // 'foo' | 'bar' | null
type Output = v.InferOutput<typeof Schema2>; // 'foo' | 'bar'

from valibot.

fabian-hiller avatar fabian-hiller commented on May 26, 2024

I tried to implement input, but there is a problem. input requires two generics to be perfectly typed. One generic for the additional input type and another for the schema. The problem is that TypeScript does not allow us to specify only one generic when calling input. TypeScript requires both generics in this case, which makes the API very complicated to use.

from valibot.

dboune avatar dboune commented on May 26, 2024

Ahh, yes, I see the issue. I'm not a type expert by any measure, but I think this has to do with the lack of "partial type argument inference. " Either we infer all type arguments, or we infer none.

The only path I can see, other than individually custom functions, is to use a curried function. For example:

import type { BaseSchema, Input, Output } from "valibot";

/**
 * Input schema type.
 */
export type InputSchema<
  TInput,
  TWrapped extends BaseSchema,
  TOutput = Output<TWrapped>,
> = BaseSchema<Input<TWrapped> | TInput, TOutput> & {
  /**
   * The schema type.
   */
  type: "input";
  /**
   * The wrapped schema.
   */
  wrapped: TWrapped;
};

/**
 * Creates a curried type-variant input schema function.
 *
 * @template TInput The type to be appended to the input type of the wrapped schema.
 *
 * @returns A curried function that creates a custom type-variant input schema.
 */
export const createInput = <TInput>() => {
  return <TWrapped extends BaseSchema>(
    wrapped: TWrapped,
  ): InputSchema<TInput, TWrapped> => {
    return {
      type: "input",
      expects: wrapped.expects,
      async: false,
      wrapped,
      _parse(input: unknown, config) {
        return this.wrapped._parse(input, config);
      },
    };
  };
};

This can be applied either like this...

const nullableInput = createInput<null>();

const RepeatSchema = nullableInput(v.picklist(['daily', 'weekly', 'monthly']));

type RepeatInput = v.Input<typeof RepeatSchema>; // "daily" | "weekly" | "monthly" | null
type RepeatOutput = v.Output<typeof RepeatSchema>; // "daily" | "weekly" | "monthly"

Or like this...

const RepeatSchema = createInput<null>()(v.picklist(['daily', 'weekly', 'monthly']));

type RepeatInput = v.Input<typeof RepeatSchema>; // "daily" | "weekly" | "monthly" | null
type RepeatOutput = v.Output<typeof RepeatSchema>; // "daily" | "weekly" | "monthly"

Certainly sub-optimal.

I'll completely understand if this isn't something you want to add to Valibot, but I'm very glad to have a solution!

from valibot.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.