TypeScript中如何为got库POST请求响应正确绑定自定义响应类型？

报错原因 #

responseType: 'json'属于got的运行时配置，TypeScript的静态类型推断无法自动感知该配置，默认会将got请求返回的body类型推导为string，和你自定义的NewAddressResponse类型不匹配，因此触发类型报错。

解决方法 #

1. 单个请求绑定类型

直接在调用got.post时传入泛型参数指定响应body的类型即可，不需要手动给解构对象标注类型：

const { body } = await got.post<NewAddressResponse>('newAddress', {
  json: {
    userId
  }
})

2. 全局实例绑定默认类型

如果你当前extend生成的got实例所有请求的响应都符合统一的JSON结构，可以在extend时直接指定默认响应类型，后续所有调用都不需要重复传泛型：

const got = got_.extend<Record<string, any>>({
  prefixUrl: serviceUrl,
  responseType: 'json'
})

注意：如果不同接口返回类型不同，不建议用全局指定的方式，单个请求传泛型灵活度更高

类型安全优化 #

可以额外加一个类型守卫函数，保证运行时类型和定义一致，同时帮助TypeScript更精准地收窄类型：

function isResponseError(body: NewAddressResponse): body is ResponseError {
  return !!body.error && typeof body.error === 'object' && 'errorCode' in body.error
}

// 业务逻辑使用
if (isResponseError(body)) {
  throw new Error(JSON.stringify(body.error))
}
return res.json({ newAddress: body.newAddress })

内容的提问来源于stack exchange，提问作者hellapea