Comments (6)
Thank you for creating this issue! This issue is related to discussion #376.
Do you have an alternative name idea for input
?
from valibot.
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.
Yes, that is correct. Thanks for the research! For now, I prefer to wait for feedback from other developers on this issue.
from valibot.
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.
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.
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)
- Conditionally validate HOT 2
- Not correct lang after set globally lang HOT 3
- `forward` not working when `transform` field throwing error HOT 3
- [i18n] add Polish(pl) language
- Record with params (key, value, pipe) return error TS2769 HOT 4
- Invalid type error while trying to parse process.env object HOT 4
- Unable to use `lazy()` in `variant()` HOT 1
- New fields in existing schema HOT 6
- Type instantiation is excessively deep and possively Infinite HOT 4
- [i18n] Add Spanish language HOT 1
- Empty array in optional as a default value turns the type into union of the type or never HOT 6
- Build error HOT 4
- Add `items` action HOT 1
- Can't run test code using 0.31.0-rc HOT 6
- Add an advanced `refine` method (similar to Zod's `superRefine`)
- [0.31.0-rc] Enable to perform transform on the first argument of pipe method HOT 2
- EMOJI_REGEX throws Invalid regular expression flags on node v18 HOT 4
- TypeScript: InferInput always infers intersect as 'never' HOT 3
- [v0.31.0-rc.5] `Invalid type: Expected Object but received Object` because of `edge` runtime HOT 1
- abortPipeEarly influnces on abortEarly HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from valibot.