total-typescript / untypeable Goto Github PK

What is the issue?

Currently the documentation references importing untypeable/client but it seems that the type definitions for this and all other exports does not seem to be working. This is likely due to the fact that types property inside of exports is not widely supported yet.

How to fix it?

For now as a workaround it is possible to import untypeable/dist/client instead but it would be good to add a typesVersions property to the package.json to add support for anyone not using NodeNext as their TypeScript module setting.

Not an issue so feel free to close or delete but would love a video on this. I dont quite understand it from the docs, not because of the docs themselves but i struggle to understand documentation in general, videos always seem to get the point across. thank you.

What is the issue?

Currently if you pass in an input where all properties are optional you are still required to pass in an empty object as a second argument. For example:

import { initUntypeable, createTypeLevelClient } from "untypeable";

const u = initUntypeable();

interface User {
  id: string;
  name: string;
};

const router = u.router({
  "/user": u.input<{ id?: string }>().output<User>(),
});

const client = createTypeLevelClient<typeof router>((path, input) => {
  return fetch(`http://localhost:3000${path}?${new URLSearchParams(input)}`).then(
    (res) => res.json(),
  );
});

const user = await client("/user", {});
//                                  ^ Without this empty object TypeScript will complain that a 2nd argument is missing

Ideally it would be better if it was checked it all properties for an input record are optional & if so make the 2nd argument for the client function optional / default to an empty object.