H
Hono•3w ago
M

createRoute Wrapper typing

This may not be entirely on topic, but perhaps someone has asked a similar question. How to preserve typing? I'm not that good at TypeScript, I understand that I need to use generics, I looked at the source code, but I still can't fully understand how to do this. Example: 
import { z, createRoute, OpenAPIHono } from '@hono/zod-openapi';

const server = new OpenAPIHono({});
type Method = 'get' | 'post' | 'put' | 'delete' | 'patch' | 'head' | 'options' | 'trace';

function customCreateRoute(
  method: Method,
  path: string,
  request: any,
  response: any
) {
  return createRoute({
    method: method,
    path: path,
    requestBody: {
      content: {
        'application/json': {
          schema: request,
        },
      },
    },
    responses: {
      200: {
        content: {
          'application/json': {
            schema: response,
          },
        },
        description: '',
      },
    },
  });
}

const route = customCreateRoute(
  'get',
  '/user/{id}',
  z.object({}),
  z.object({ name: z.string() })
);

server.openapi(route, async (context) => {
  const id = context.req.param('id');
  return context.json({});
});
import { z, createRoute, OpenAPIHono } from '@hono/zod-openapi';

const server = new OpenAPIHono({});
type Method = 'get' | 'post' | 'put' | 'delete' | 'patch' | 'head' | 'options' | 'trace';

function customCreateRoute(
  method: Method,
  path: string,
  request: any,
  response: any
) {
  return createRoute({
    method: method,
    path: path,
    requestBody: {
      content: {
        'application/json': {
          schema: request,
        },
      },
    },
    responses: {
      200: {
        content: {
          'application/json': {
            schema: response,
          },
        },
        description: '',
      },
    },
  });
}

const route = customCreateRoute(
  'get',
  '/user/{id}',
  z.object({}),
  z.object({ name: z.string() })
);

server.openapi(route, async (context) => {
  const id = context.req.param('id');
  return context.json({});
});
8 Replies
atoko
atoko•3w ago
Not sure if it will completely fix it, but prefer to use “unknown” over “any”. Unknown = could be anything, but it’s still some type Any = opt out of types completely
M
MOP•3w ago
Thanks for the advice! I set this type as temporary. In theory, I should substitute the type from the generic there. But I don't know how to implement it
ambergristle
ambergristle•3w ago
i like to think of generics as functions for types you pass in a type parameter, and you get back some resolved type 
type Method = //...

function customCreateRoute<
  M extends Method,
  P extends string,
  Req extends Record<string, unknown>,
  Res extends Record<string, unknown>,
>(
  method: M,
  path: P,
  request: Req,
  response: Res,
) {
  // fn body
}
type Method = //...

function customCreateRoute<
  M extends Method,
  P extends string,
  Req extends Record<string, unknown>,
  Res extends Record<string, unknown>,
>(
  method: M,
  path: P,
  request: Req,
  response: Res,
) {
  // fn body
}
M
MOP•3w ago
I also thought about some such option, but it still doesn’t work. Hono loses the ability to infer type when I do this
M
MOP•3w ago
I'm talking about the infer that is described here https://hono.dev/docs/guides/best-practices
Best Practices - Hono
Web framework built on Web Standards for Cloudflare Workers, Fastly Compute, Deno, Bun, Vercel, Node.js, and others. Fast, but not only fast.
atoko
atoko•3w ago
It has to do with the defaults on Hono<>, I think. You have to ES =infer.ExtractSchema<Hono>, EE = infer.ExtractEnv<Hono> every time you have another layer of generic, because you need to pass down Hono<ES, EE, string> the default Hono generic is Hono<BlankEnv, BlankSchema, ...>
M
MOP•3w ago
I think I solved the problem by adding "const" before the types in the generics. Thanks!
ambergristle
ambergristle•3w ago
what do you mean by this? it doesn't sound right

Did you find this page helpful?