Hono•4w ago

how can I specify the return type of the response of API response

FBI_kingmohbil · 2024-08-24T00:29:51.541Z

For example I want to do something like this ```ts type a = (c:any) => JSON<{message: string}> c.get('/', (): a => {}) ```

For example I want to do something like this

type a = (c:any) => JSON<{message: string}>
c.get('/', (): a => {})

type a = (c:any) => JSON<{message: string}>
c.get('/', (): a => {})

6 Replies

Joydip Roy•4w ago

type JSONRespondReturn<
  T extends JSONValue | SimplifyDeepArray<unknown> | InvalidJSONValue,
  U extends StatusCode
> = Response &
  TypedResponse<
    SimplifyDeepArray<T> extends JSONValue
      ? JSONValue extends SimplifyDeepArray<T>
        ? never
        : JSONParsed<T>
      : never,
    U,
    'json'
  >

type JSONRespondReturn<
  T extends JSONValue | SimplifyDeepArray<unknown> | InvalidJSONValue,
  U extends StatusCode
> = Response &
  TypedResponse<
    SimplifyDeepArray<T> extends JSONValue
      ? JSONValue extends SimplifyDeepArray<T>
        ? never
        : JSONParsed<T>
      : never,
    U,
    'json'
  >

- This type is designed to automatically infer and define the data types used within Hono applications. - It eliminates the need for manual type declarations, making development more efficient and reducing the risk of type-related errors. - Hono analyzes the structure and content of your data to determine its underlying types. - This includes identifying objects, arrays, primitives (like strings, numbers, booleans), and more complex structures. - Hono infers the appropriate TypeScript types for your data based on the analysis. For example, if your data contains an object with certain properties and values, Hono might infer an interface type that describes those properties and their types.

FBI_kingmohbil•4w ago

The thing is I want to have control over the API responses to define for example this type

interface Response<T> {
  message: string;
  data: T;
}

interface Response<T> {
  message: string;
  data: T;
}

and I want to enforce that on every single route, just so I don't forget to write those and to stay semantic as possible in the responses so then in the development time, I would need less time writing unit-tests and the typescript compiler will let me know if I violated this, which I'm not saying I shouldn't write unit tests defiantly I should but this will make my development easier to manages especially If I'm working with a team that isn't that solid to grasp these points

Joydip Roy•4w ago

Got it, in that case, you can do following

import { Hono, TypedResponse } from 'hono'

interface Response<T> {
  message: string;
  data: T;
}

const app = new Hono()

app.get('/', (c): TypedResponse<Response<string>, 200> => {
  return c.json({
    message: 'success',
    data: 'Hello Hono!'
  })
})

import { Hono, TypedResponse } from 'hono'

interface Response<T> {
  message: string;
  data: T;
}

const app = new Hono()

app.get('/', (c): TypedResponse<Response<string>, 200> => {
  return c.json({
    message: 'success',
    data: 'Hello Hono!'
  })
})

FBI_kingmohbil•4w ago

That's perfect thanks Okay I'm using it inside createMiddleware how can I do that TypedResponse<LoginResponse | ErrorResponseType> this is my typed definition

createMiddleware(async (c): TypedResponse<LoginResponse | ErrorResponseType>

createMiddleware(async (c): TypedResponse<LoginResponse | ErrorResponseType>

Joydip Roy•4w ago

You can't apply any custom type for custom middleware. Here is the reason, Unlike the previous solution, the router has the 'HandlerInterface' type, H<E2, P, I, R>. Here R is HandlerResponse<any> which uses TypedResponse<>. That's why a custom response can be attached. But the middleware return typed MiddlewareHandler<E, P, I> where E stands for Environment, P stands for Path (always string), and I stands for Input which can be further typed for inand out If you see the MiddlewareHandler it doesn't have R so it can't be extended or can't be applied any custom type for return.

FBI_kingmohbil•4w ago

Ah okay thanks

Gaming

Programming

how can I specify the return type of the response of API response