TypeScript cannot figure out which Got type to use #954

scttcper · 2019-12-01T23:29:25Z

What would you like to discuss?

With @types/got we could use type GotOptions and be able to pass this to got.get(options) however with v10 the types are string | OptionsOfDefaultResponseBody and OptionsOfDefaultResponseBody and its friends are not available to import at the root of the project. I was wondering if this was on purpose.

What i'm looking for and not sure how to do with v10

const options: GotOptions = {
	url: 'https://example.com',
};
const response = await got(options);

Also, this example from the docs isn't working for me and I'm wondering if it should accept a partial? Opened #953 with a demo

got.mergeOptions(got.defaults.options, {
	responseType: 'json',
});

Checklist

I have read the documentation.

Really excited about the release of v10 🎉

The text was updated successfully, but these errors were encountered:

szmarczak · 2019-12-02T12:36:18Z

What i'm looking for and not sure how to do with v10

I don't understand the example. The URL is invalid.

yovanoc · 2019-12-02T12:39:25Z

We have this error when we try to do that

The only way I had to manage this is to do an as const and don't declare as GotOptions like this:

const options = {
    method,
    cookieJar,
    agent,
    responseType: "json",
    form,
    headers
  } as const;

await got(url, options);

scttcper · 2019-12-02T15:36:56Z

I don't understand the example. The URL is invalid.

Sorry was being too terse. There would be a bunch of properties and a valid url passed to options, there just isn't a good type to import and use.

szmarczak · 2019-12-02T17:01:23Z

const options: GotOptions = {
	url: 'https://example.com'
};

This is correct. The example:

const response = await got(options);

fails because it tries to use

<T>(url: string | Merge<Options, {isStream: true}>, options?: Merge<Options, {isStream: true}>): ProxyStream<T>;

instead of

<T = string>(url: string | OptionsOfDefaultResponseBody, options?: OptionsOfDefaultResponseBody): CancelableRequest<Response<T>>

The Got interface looks like:

export type OptionsOfDefaultResponseBody = Merge<Options, {isStream?: false; resolveBodyOnly?: false; responseType?: 'default'}>;
type OptionsOfTextResponseBody = Merge<Options, {isStream?: false; resolveBodyOnly?: false; responseType: 'text'}>;
type OptionsOfJSONResponseBody = Merge<Options, {isStream?: false; resolveBodyOnly?: false; responseType: 'json'}>;
type OptionsOfBufferResponseBody = Merge<Options, {isStream?: false; resolveBodyOnly?: false; responseType: 'buffer'}>;
type ResponseBodyOnly = {resolveBodyOnly: true};

interface GotFunctions {
	// `asPromise` usage
	<T = string>(url: string | OptionsOfDefaultResponseBody, options?: OptionsOfDefaultResponseBody): CancelableRequest<Response<T>>;
	(url: string | OptionsOfTextResponseBody, options?: OptionsOfTextResponseBody): CancelableRequest<Response<string>>;
	<T>(url: string | OptionsOfJSONResponseBody, options?: OptionsOfJSONResponseBody): CancelableRequest<Response<T>>;
	(url: string | OptionsOfBufferResponseBody, options?: OptionsOfBufferResponseBody): CancelableRequest<Response<Buffer>>;

	// `resolveBodyOnly` usage
	<T = string>(url: string | Merge<OptionsOfDefaultResponseBody, ResponseBodyOnly>, options?: Merge<OptionsOfDefaultResponseBody, ResponseBodyOnly>): CancelableRequest<T>;
	(url: string | Merge<OptionsOfTextResponseBody, ResponseBodyOnly>, options?: Merge<OptionsOfTextResponseBody, ResponseBodyOnly>): CancelableRequest<string>;
	<T>(url: string | Merge<OptionsOfJSONResponseBody, ResponseBodyOnly>, options?: Merge<OptionsOfJSONResponseBody, ResponseBodyOnly>): CancelableRequest<T>;
	(url: string | Merge<OptionsOfBufferResponseBody, ResponseBodyOnly>, options?: Merge<OptionsOfBufferResponseBody, ResponseBodyOnly>): CancelableRequest<Buffer>;

	// `asStream` usage
	<T>(url: string | Merge<Options, {isStream: true}>, options?: Merge<Options, {isStream: true}>): ProxyStream<T>;
}

And if we do:

type CorrectGotType = <T = string>(url: string | OptionsOfDefaultResponseBody, options?: OptionsOfDefaultResponseBody) => CancelableRequest<Response<T>>;

const typedInstance = instance as CorrectGotType;
await typedInstance(options as GotOptions);

it still fails because:

Argument of type 'GotOptions' is not assignable to parameter of type 'Merge<Merge<RequestOptions, Merge<GotOptions, URLOptions>>, { isStream?: false | undefined; resolveBodyOnly?: false | undefined; responseType?: "default" | undefined; }>'.
  Type 'GotOptions' is not assignable to type '{ isStream?: false | undefined; resolveBodyOnly?: false | undefined; responseType?: "default" | undefined; }'.
    Types of property 'isStream' are incompatible.
      Type 'boolean | undefined' is not assignable to type 'false | undefined'.
        Type 'true' is not assignable to type 'false | undefined'.ts(2345)

TS is dumb, because it ignores the fact that we handle isStream seperately for true and false.

szmarczak · 2019-12-02T17:54:31Z

microsoft/TypeScript#24929 (comment)

szmarczak · 2019-12-02T18:58:18Z

If we extend GotFunctions by

	// Generic usage
	<T>(url: string | Options, options?: Options): CancelableRequest<T> | ProxyStream<T>;

then it would pass but you would have to cast it as CancelableRequest<Response<string>> by yourself which is not convenient.

~~The fix would be to use T extends OptionsOfResultA ? A : T extends OptionsOfResult B ? B : ... as it works as expected.~~ It doesn't work as expected.

sindresorhus · 2019-12-02T19:03:45Z

// @pmmmwh

viceice · 2019-12-03T06:16:08Z

Workaround:

type OptionsOfJSONResponseBody = Merge<
    Options,
    {
        isStream?: false;
        resolveBodyOnly?: false;
        responseType: 'json';
    }
>;
await got<ResultType>(url, opts as OptionsOfJSONResponseBody)

pmmmwh · 2019-12-03T17:59:04Z

// @pmmmwh

I am thinking, maybe we should expose some of the internal option types to the outside world? Or instead, exporting a type for promise and another one for stream?

That seems like a good idea to make sure TypeScript infers them correctly. For example, the following works:

const options: OptionsOfDefaultResponseBody = {
	url: 'https://example.com',
};
const response = await got(options);

Edit:
Actually, thinking about it - part of the issue is that we strictly type options' responseType/isStream/resolveBodyOnly properties, while in the actual world if the user does not do as const an object (even with responseType: 'text' or isStream: false) will always be considered as responseType?: string/isStream?: boolean. This make all our specific overloads fail and thus fallback to the last one, which is the one for streams. I will have to test if we can workaround that while typing with high specificity.

mrhyde · 2020-01-09T03:41:10Z

@pmmmwh is right about the bigger picture of this issue. Just trying to proxy arguments types to nested function

  const queuedGet = (...args: Parameters<GotFunctions>) =>
    queue.add(() => got.get(...args))

will fail with error

Types of property 'isStream' are incompatible.
  Type 'false | undefined' is not assignable to type 'true'.

P.S. I have submitted a PR for exporting GotFunctions interface #1017

novemberborn · 2020-01-09T16:51:45Z

TS is dumb, because it ignores the fact that we handle isStream seperately for true and false.

Put differently, the type definitions in Got are so complex they're bumping up against TypeScript's limits.

There's little point railing against TypeScript here. Got's ideal API may just not be expressible. You should consider moving a little closer to what TypeScript can handle.

With my compile errors so far, it seems like providing the URL as a url property fixes things.

szmarczak · 2020-01-09T17:40:21Z

Put differently, the type definitions in Got are so complex they're bumping up against TypeScript's limits.

See function overloads. The same should be possible when using interfaces IMO.

lagden · 2020-01-20T01:57:41Z

go back to the old and good JavaScript...
you are making up problems. IMO.

bkhartmire · 2020-01-21T19:13:55Z

I was coming across this error as well when trying to use got.post and pass in options.

Argument of type 'GotOptions' is not assignable to parameter of type 'Merge<Merge<RequestOptions, Merge<GotOptions, URLOptions>>, { isStream?: false | undefined; resolveBodyOnly?: false | undefined; responseType?: "default" | undefined; }>'.
  Type 'GotOptions' is not assignable to type '{ isStream?: false | undefined; resolveBodyOnly?: false | undefined; responseType?: "default" | undefined; }'.
    Types of property 'isStream' are incompatible.
      Type 'boolean | undefined' is not assignable to type 'false | undefined'.
        Type 'true' is not assignable to type 'false | undefined'.ts(2345)

It worked when I used got.extend instead.

const body = {example: 'hello'}

const api = got.extend({
    prefixUrl: 'example.com',
    responseType: 'json',
});

const res = await api('/endpoint', {method: 'POST', json: body})

cah-kyle-dunn · 2020-01-28T21:39:01Z

The entire problem is a result of the dynamic return type being inferred from values in the options object. IMO the simplest workaround is to avoid using the isStream, responseType and resolveBodyOnly options altogether.

// got.get<CustomType>(url, { responseType: 'json' })
got.get(url).json<CustomType>()

// got.get(url, { responseType: 'blob' })
got.get(url).blob()

// got.get(url, { responseType: 'text' })
got.get(url).text()

// got.get(url, { isStream: true })
got.stream(url)

This allows for a base options type that always matches the default overload (i.e. OptionsOfDefaultResponseBody).

type StrictOptions = Omit<Options, 'isStream' | 'responseType' | 'resolveBodyOnly'>

I might even suggest StrictOptions be an exported type from got.

resynth1943 · 2020-02-14T01:10:31Z

I'm bumping up against something with the typings, although it might not be related to this issue. After an update, it no longer seems possible to import FormOptions and friends from got; This breaks my code.

I also can't import GotPromise and a load of other stuff. What is happening? Do we know of any solutions to this yet?

resynth1943 · 2020-02-14T14:23:55Z

Well if we don't, I'll explore other alternatives. This is really weird, as it was working great last time I checked.

Thanks anyway for the package, Sindre. ❤️

mrhyde · 2020-02-24T02:31:06Z

@resynth1943 I'm not sure where you managed to find FormOptions but there was no such export unless you are confusing it with GotOptions

resynth1943 · 2020-02-24T02:40:49Z

Nope. I'm pretty sure it exported something named FormOptions. Possibly GotFormOptions. Nevertheless, my code was using it, so it most likely exists, unless the setup was invalid.

mrhyde · 2020-02-24T04:42:43Z

You were using @types/got which was made for an older version. You need to update your code to v10 or rollback. It has nothing to do with this issue.

resynth1943 · 2020-02-24T13:57:41Z

You were using @types/got which was made for an older version. You need to update your code to v10 or rollback. It has nothing to do with this issue.

Well that package has a lot of weekly downloads. 171,998, to be exact. It's an understandable point of confusion. 😛

viceice · 2020-02-24T14:06:03Z

Maybe someone should add a package removal pr to for @types/got

cesarfd · 2020-02-24T14:08:12Z

Or just mark it as deprecated. El lun., 24 feb. 2020 a las 15:06, Michael Kriese (<notifications@github.com>) escribió:

…

Maybe someone should add a package removal pr <https://github.com/DefinitelyTyped/DefinitelyTyped#removing-a-package> to for @types/got — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#954?email_source=notifications&email_token=ACTTGMQDGD6WOIZQ6KUSAK3REPH43A5CNFSM4JTOJM22YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEMX4YOQ#issuecomment-590335034>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ACTTGMTXRGZ7NE5UOACRU3DREPH43ANCNFSM4JTOJM2Q> .

viceice · 2020-02-24T14:12:42Z

That what the link above does, it will remove the types from the repo and pushes a new version to npm with deprecation notice

szmarczak · 2020-02-24T14:29:34Z

Maybe someone should add a package removal pr to for @types/got

Some people are still using Got 9 so removal is inappropriate

viceice · 2020-02-24T14:32:45Z

the type are still available on npm, they will only be removed from git repo. on npm only a new deprecated version (here major) will be published.

rifler · 2020-03-05T11:00:25Z

My problem is that some of my dependencies use got@9 and @types/got. So i cant update my project to 10 before i update that dependencies.

maybe we should create two new packages got-legacy and @types/got-legacy with all history from got@9 and behind.
After that changing dependencies will be easy - just replace require('got') to require('got-legacy') without additional testing.
And after that you can update your project to use got@10

scttcper · 2020-03-05T20:02:49Z

This issue is about v10 stream vs cancellable request response types not 10’s built in types vs 9’s definitely typed package.

mattddean · 2024-10-08T22:24:07Z

Another workaround for those still using Got v10

const textRequest = got.extend({ responseType: 'text' })
const res = await textRequest.put('https://api.example.com/v1/whatever', {
  json: { some: 'property' },
})

szmarczak added types The issue is related to TypeScript ✭ help wanted ✭ labels Dec 2, 2019

This comment has been minimized.

Sign in to view

szmarczak added the external The issue related to an external project label Dec 2, 2019

szmarczak changed the title ~~migrating from GotOptions~~ TypeScript cannot figure out which Got type to use Dec 2, 2019

This was referenced Feb 6, 2020

Rewrite Got #1051

Merged

Option types unnecessarily closed #1060

Closed

feat(deps): upgrade to got v10 renovatebot/renovate#5469

Closed

szmarczak mentioned this issue Feb 19, 2020

Setting responseType in options results in TS2769: No overload matches this call #1079

Closed

2 tasks

szmarczak added a commit to szmarczak/got that referenced this issue Feb 29, 2020

test sindresorhus#954

9361722

szmarczak added a commit to szmarczak/got that referenced this issue Mar 3, 2020

test sindresorhus#954

3b815f3

szmarczak added a commit to szmarczak/got that referenced this issue Mar 4, 2020

test sindresorhus#954

c9b663b

szmarczak mentioned this issue Mar 16, 2020

Can’t use type with responseType option #1122

Closed

2 tasks

sindresorhus closed this as completed in #1051 Apr 12, 2020

snyk-bot mentioned this issue Apr 23, 2020

[Snyk] Upgrade got from 11.0.0 to 11.0.1 montumodi/mongodb-stitch-api-client#2

Merged

kschat mentioned this issue May 19, 2020

Provide an overload for unknown responseType #1276

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

TypeScript cannot figure out which Got type to use #954

TypeScript cannot figure out which Got type to use #954

scttcper commented Dec 1, 2019 •

edited

Loading

szmarczak commented Dec 2, 2019

yovanoc commented Dec 2, 2019

scttcper commented Dec 2, 2019

szmarczak commented Dec 2, 2019

szmarczak commented Dec 2, 2019

This comment has been minimized.

szmarczak commented Dec 2, 2019 •

edited

Loading

sindresorhus commented Dec 2, 2019

viceice commented Dec 3, 2019 •

edited

Loading

pmmmwh commented Dec 3, 2019 •

edited

Loading

mrhyde commented Jan 9, 2020

novemberborn commented Jan 9, 2020

szmarczak commented Jan 9, 2020

lagden commented Jan 20, 2020

bkhartmire commented Jan 21, 2020 •

edited

Loading

cah-kyle-dunn commented Jan 28, 2020 •

edited

Loading

resynth1943 commented Feb 14, 2020 •

edited

Loading

resynth1943 commented Feb 14, 2020

mrhyde commented Feb 24, 2020

resynth1943 commented Feb 24, 2020

mrhyde commented Feb 24, 2020

resynth1943 commented Feb 24, 2020

viceice commented Feb 24, 2020

cesarfd commented Feb 24, 2020 via email

viceice commented Feb 24, 2020

szmarczak commented Feb 24, 2020

viceice commented Feb 24, 2020

rifler commented Mar 5, 2020 •

edited

Loading

scttcper commented Mar 5, 2020

mattddean commented Oct 8, 2024

TypeScript cannot figure out which Got type to use #954

TypeScript cannot figure out which Got type to use #954

Comments

scttcper commented Dec 1, 2019 • edited Loading

What would you like to discuss?

Checklist

szmarczak commented Dec 2, 2019

yovanoc commented Dec 2, 2019

scttcper commented Dec 2, 2019

szmarczak commented Dec 2, 2019

szmarczak commented Dec 2, 2019

This comment has been minimized.

szmarczak commented Dec 2, 2019 • edited Loading

sindresorhus commented Dec 2, 2019

viceice commented Dec 3, 2019 • edited Loading

pmmmwh commented Dec 3, 2019 • edited Loading

mrhyde commented Jan 9, 2020

novemberborn commented Jan 9, 2020

szmarczak commented Jan 9, 2020

lagden commented Jan 20, 2020

bkhartmire commented Jan 21, 2020 • edited Loading

cah-kyle-dunn commented Jan 28, 2020 • edited Loading

resynth1943 commented Feb 14, 2020 • edited Loading

resynth1943 commented Feb 14, 2020

mrhyde commented Feb 24, 2020

resynth1943 commented Feb 24, 2020

mrhyde commented Feb 24, 2020

resynth1943 commented Feb 24, 2020

viceice commented Feb 24, 2020

cesarfd commented Feb 24, 2020 via email

viceice commented Feb 24, 2020

szmarczak commented Feb 24, 2020

viceice commented Feb 24, 2020

rifler commented Mar 5, 2020 • edited Loading

scttcper commented Mar 5, 2020

mattddean commented Oct 8, 2024

scttcper commented Dec 1, 2019 •

edited

Loading

szmarczak commented Dec 2, 2019 •

edited

Loading

viceice commented Dec 3, 2019 •

edited

Loading

pmmmwh commented Dec 3, 2019 •

edited

Loading

bkhartmire commented Jan 21, 2020 •

edited

Loading

cah-kyle-dunn commented Jan 28, 2020 •

edited

Loading

resynth1943 commented Feb 14, 2020 •

edited

Loading

rifler commented Mar 5, 2020 •

edited

Loading