Response body type conversion to interface

[vickyRathee]

I don't see any example on documentation to convert the response body to type T. I just need the response body as Array<Jobs> instead string.

I tried this

const response: Array<Jobs>  = await this._agentyApi(url, { method: "GET" });

and this

const response:   = await this._agentyApi<Array<Jobs>>(url, { method: "GET" });

But none of these supported

Here is full code

import got, { GotOptions } from "got";
import { Jobs } from "../models/jobs";

export class ApiService {
  _agentyApi: got.GotInstance;

  constructor() {
    this._agentyApi = got.extend({
      baseUrl: process.env.API_URL,
      throwHttpErrors: false,
      json: true,
      headers: {
        "Content-Type": "application/json;charset=UTF-8",
      },
    });
  }

  async getJobsAsync(): Promise<Array<Jobs>> {
    const url = "/queue";
    const response = await this._agentyApi<Array<Jobs>>(url, { method: "GET" });
    
    return response 
  }
}

Checklist

• I have read the documentation.

[sindresorhus]

the easiest way is to use the .json<T>() method:

interface Job {
	id: string;
	title: string;
}

const jobs = await got(url).json<Job[]>();
// jobs is typed as Job[]

Alternatively, if you use the generic on the got call itself, you need to set both responseType: 'json' and resolveBodyOnly: true:

const jobs = await got<Job[]>(url, {
	responseType: 'json',
	resolveBodyOnly: true
});

without resolveBodyOnly: true, you get the full response object and need to acces .body:

const response = await got<Job[]>(url, {
	responseType: 'json'
});
const jobs = response.body; // Job[]