CancelableRequest.json() returns CancelableRequest and not Promise

[Inrixia]

What would you like to discuss?

I'm in the process of updating to the latest version of got. According to the docs CancelableRequest.json() returns a Promise

However the types specified for got show it returning a CancelableRequest which means I just can't get a proper object out of it???

got/source/as-promise/types.ts

Line 36 in f0ac0b3

json: <ReturnType>() => CancelableRequest<ReturnType>;

Honestly the whole change from promises to CancelableRequests is rather confusing, most of the docs refer to got returning a Promise while the new types all use CancelableRequest which doesn't support any of the usual Promise interface... Is there something I'm missing?

Checklist

• I have read the documentation.

[sindresorhus]

According to the docs CancelableRequest.json() returns a Promise

It technically does. CancelableRequest extends PCancelable which extends Promise.

[Inrixia]

@sindresorhus any help?

[szmarczak]

Most likely it's an issue with TypeScript on your end or either it's a bug in TypeScript language server.

[Inrixia]

Thanks, checked through and it was a sneaky typing issue due to capitalization in one of the core files. After fixing it typing is working correctly now

[cmjacques]

Hi @Inrixia - can you explain your solution a bit further? I've run into the same thing. Thanks.

[Inrixia]

@cmjacques sure. I beleive the capitalization between versions has changed. You can see a working example in this repo https://github.com/Inrixia/floatplaneAPI.ts/blob/main/src/index.ts