JSDoc comments

[babakfp]

Hi 👋

It would be great to get those JSDoc comments to work in these types:

export type OptionsInput = v.Input<typeof OptionsSchema>
export type OptionsOutput = v.Output<typeof OptionsSchema>

When I pass OptionsInput to a function argument the user can see those comments.

(I don't know if this is even possible or not).

[fabian-hiller]

I agree! But I am not sure either. Feel free to research it if you have the time. Maybe @ssalbdivad knows the answer.

[ssalbdivad]

@fabian-hiller In fact it's kind of the opposite- the simpler the implementation for inference, the more likely this will work.

That said, depending on what advanced mappings you might need to do, it may not be possible; it's largely not possible in ArkType because of how keys are parsed 😞

[fabian-hiller]

Then it could work for Valibot. I may will get back to you on this in a couple of months.

[Dimava]

@fabian-hiller general idea is that the thing that points to JSDoc is keyof and as long as you keep it's keyofness the JSDoc will persist.

// keeps JSDoc
type MyOmit1<T, K> = {[P in keyof T as P extends K ? never : P]: T[P]}
// loses JSDoc
type MyOmit1<T, K> = {[P in Exclude<keyof T, K>]: T[P]}
// loses JSDoc
type MyOmit1<T, K> = {[P in (keyof T) & string]: T[P]}
// loses JSDoc
type MyOmit1<T, K> = {[P in keyof T as `${P}`]: T[P]}

[Dimava]

I've failed to rename keys while keeping JSDoc iirc btw

[fabian-hiller]

Thanks for the hint!