Improve types

[pmmmwh]

This is a follow-up to #928 . Hopefully this is the last batch of (type breaking?) changes 🤞 .

Changes

• Remove force casting when appropriate (some are left cause they are intended to be errors)
• Better exported types so that users wouldn't have to force cast
• Lint project to fully comply with XO rules
• All TODO comments related to types should have been resolved by Make TypeScript types conforms to strict mode #928 or this PR
• All fixable ts-ignore comments should have been removed by Make TypeScript types conforms to strict mode #928 or this PR
• All non-fixable ts-ignore comments should have a description stating what happened there
• Refactor/Write/Copy-n-Paste Doc-String for exported types

Checklist

• I have read the documentation.
• I have included a pull request description of my changes.

[sindresorhus]

Did you see #876 (comment) ?

DefinitelyTyped/DefinitelyTyped#34960

[pmmmwh]

Did you see #876 (comment) ?

DefinitelyTyped/DefinitelyTyped#34960

I actually just read that. Should we just augment the global scope and add the two classes there? I don't see another way out ...

[sindresorhus]

I actually just read that. Should we just augment the global scope and add the two classes there? I don't see another way out ...

Yeah, we can do that for now.

[pmmmwh]

Pushed a commit to finish up the work on ts-ignore comments. Afaik most of the work related to types (other than doc strings) should be done?

[sindresorhus]

One more that could use a better type:

got/source/as-stream.ts

Line 17 in d968e49

const piped = new Set<any>(); // TODO: Should be `new Set<stream.Writable>();`.

And maybe also:

got/test/helpers/with-server.ts

Line 30 in d968e49

// @ts-ignore FIXME: Incompatible union type signatures

[sindresorhus]

Regarding the doc strings. I think that should be a separate PR after this one. I'd like to get this one merged asap so we can do the final Got v10 release.

[szmarczak]

Also I've fixed some types here: https://github.com/sindresorhus/got/pull/833/files#diff-05c76183bbee7e002aa6711e6baca2ef so you may want to take a look and fix it here also.

[szmarczak]

LGTM but it'd be nice if you merged my fixes into this PR, I don't expect my PR to get merged before yours.

[pmmmwh]

One more that could use a better type:

got/source/as-stream.ts

Line 17 in d968e49

const piped = new Set<any>(); // TODO: Should be `new Set<stream.Writable>();`.

And maybe also:

got/test/helpers/with-server.ts

Line 30 in d968e49

// @ts-ignore FIXME: Incompatible union type signatures

The first one - I think the interface is actually 100% equal to the ServerResponse class from the 'http' library? I checked stream.Writable and it didn't seem to have a good fit of properties.

The second one - I haven't found a way to work around that. It seems to be a TypeScript problem as stated here? I can try removing the generics for CancelableRequest and ProxyStream (as suggested as a cause by someone in the thread) and see if it fixes that.

[pmmmwh]

LGTM but it'd be nice if you merged my fixes into this PR, I don't expect my PR to get merged before yours.

@szmarczak Do you want me to pull in all changes related to types from there? I am particularly not very confident on pulling in changes in this file, since there is some change in normalization logic too?

[szmarczak]

I'll send a PR to your PR (types-follow-up branch) ;)

[szmarczak]

@pmmmwh Sent you a PR ;)

[szmarczak]

If you've got any questions, feel free to ask. This is great work! :D

[pmmmwh]

If you've got any questions, feel free to ask. This is great work! :D

Checked and merged 😺

[sindresorhus]

Awesome! Thanks for all your work on this, @pmmmwh! We could not have done this without you. 🙌