sindresorhus/got

TypeScript cannot infer the correct type for response.body in got responses

jasonwwl opened this issue · 2 comments

Describe the bug

  • Node.js version: 20.15.0
  • OS & version: Ubuntu 20.04
  • Got version: 14.4.1
  • TypeScript version: 5.5.3

TypeScript cannot correctly infer the type for response.body in got responses when using generics.

Actual behavior

TypeScript infers the type of response.body as any despite specifying a generic type for the response, leading to loss of type safety.

image

Expected behavior

TypeScript should infer the type of response.body based on the generic type specified in the got request, ensuring type safety.

Code to reproduce

import got, { Method, Response } from 'got';

interface ApiResponse<T> {
  code: number;
  message: string;
  result: T;
  success: boolean;
  timestamp: number;
}

async function fetchData<R>(url: string, method: Method, data?: unknown): Promise<R> {
  try {
    const response: Response<ApiResponse<R>> = await got<ApiResponse<R>>({
      url,
      method,
      headers: {
        'Content-Type': 'application/json'
      },
      json: data,
      responseType: 'json'
    });

    // this response.body is 'any'
    return response.body.result;
   
  } catch (e: any) {
    throw new Error(`Request failed: ${e.message}`);
  }
}

(async () => {
  const result = await fetchData<{ accessToken: string }>('https://example.com/api/token', 'POST', { key: 'value' });
  console.log(result.accessToken); // TypeScript should infer the correct type here
})();

Checklist

  • I have read the documentation.
  • I have tried my code with the latest version of Node.js and Got.