Got: Make the TypeScript types strict and better

[sindresorhus]

We have successfully transitioned to TypeScript, but we have not yet enabled strict mode. Although some of the files have strict types, there's still a lot of work to properly type everything.

If you want to take on this issue, it's expected that you have deep TypeScript understanding and experience. It's not an easy issue. Comment if you decide to start on this to prevent duplicate work.

I suggest the following order of fixing things (can be multiple PRs):

• [x] Remove "strict": false, in tsconfig.json and properly type what's required just to get it to compile ($ npm test should pass).
• [x] Improve existing typing and ensure everything has as specific and correct types are possible. (Some progress has been made: https://github.com/sindresorhus/got/pull/760)
• [x] Remove noImplicitReturns from tsconfig.json and fix any errors.
• [x] Remove noUnusedParameters from tsconfig.json and fix any errors.
• [x] Remove these lines in package.json and fix errors.
• [x] Fix type-related TODO comments.
• [x] Remove // @ts-ignore comments and fix the errors.
• [ ] Add doc comments to public (meaning exported) functions/types/interfaces. Borrow text from readme. This especially applies to the options and the main Got interface. Follow this style: https://github.com/sindresorhus/typescript-definition-style-guide#documentation
• [ ] Use readonly and const assertions wherever possible: https://devblogs.microsoft.com/typescript/announcing-typescript-3-4/

---

IssueHunt Summary

pmmmwh has been rewarded.

Backers (Total: $180.00)

• issuehunt ($180.00)

Submitted pull Requests

• #797 src: Work on strict ts migrations
  

  - #928 Make TypeScript types conforms to strict mode

Tips

• Checkout the Issuehunt explorer to discover more funded issues.
• Need some help from other developers? Add your repositories on IssueHunt to raise funds.
  

[paulmelnikow]

The work I did at https://github.com/sindresorhus/got/issues/700#issuecomment-466831401 will need to be rebased. I will probably need some pointers about how to resolve some of the remaining issues. Is that something you'd be able to help with / is it worth doing that?

[IssueHuntBot]

@issuehunt has funded $180.00 to this issue.

---

• Submit pull request via IssueHunt to receive this reward.
• Want to contribute? Chip in to this issue via IssueHunt.
• Checkout the IssueHunt Issue Explorer to see more funded issues.
• Need help from developers? Add your repository on IssueHunt to raise funds.

[sindresorhus]

@paulmelnikow I'm not sure how much my review will help. Making Got strict was more over my current TS knowledge than I realized.

[paulmelnikow]

Would it be helpful to incrementally add the parts for which I _was_ able to identify good types?

[sindresorhus]

Yes, definitely.

[paulmelnikow]

Out of curiosity, why did you remove noImplicitReturns from the top post instead of checking it off? It's nice to feel like progress has been made. Also the second bullet isn't done, but could reference #760 which made significant progress.

[sindresorhus]

@paulmelnikow It was only half of the bullet point, so was easier to remove it than to move it to a new one and check it, but done now.

[paulmelnikow]

Ah, I gotcha. Thanks!

[tobenna]

I'm working on:

Remove "strict": false, in tsconfig.json and properly type what's required just to get it to compile ($ npm test should pass).

https://github.com/sindresorhus/got/compare/master...tobenna:strict-ts

[mastermatt]

I understand the TS migration is still a wip (big fan), but at this time do consumers of this lib still need to use @types/got?

[sindresorhus]

@mastermatt Yes

[AxelTerizaki]

I'm not sure if I should open a new issue or post it here, so here goes :

I'm transitionning my own app to Typescript and installed @types/got

However, I'm running into a TS error with this bit of code :

const res = await got.stream(`https://${instance}/avatars/${avatarFile}`, {
        stream: true
    });
const avatarPath = resolve(getState().appPath, conf.System.Path.Temp, avatarFile);
await writeStreamToFile(res, avatarPath);

I'm not sure if there's a better way to use streams and promises, but in this case it worked just fine before I transitionned to Typescript. Now, I get the following error :

Argument of type '{ stream: boolean; }' is not assignable to parameter of type 'GotOptions'.
Object literal may only specify known properties, and 'stream' does not exist in type 'GotOptions'.

Hope this helps in making types better for Got... or if someone knows a workaround/solution because I did something wrong, I'm all ears.

[sindresorhus]

I'm transitionning my own app to Typescript and installed @types/got

We don't control @types/got. You need to open an issue on https://github.com/DefinitelyTyped/DefinitelyTyped

await got.stream is also moot as await a non-promise does nothing. Remove the await.

[ejmartin504]

I would love to help out with this issue, even though I'm a bit of a TS n00b. What would be the best bullet point to work on?

[sindresorhus]

@ejmartin504 You could remove the "strict": false, config temporarily, fix/improve some types, and then put "strict": false, back again. We also need help adding doc comments (taken from the readme).

[vladfrangu]

Hello!

I'd like to help out with this issue, with making the project strict and fulfill the list. What do I need to do to get started? 😄

[yakov116]

@vladfrangu the comment above yours

You could remove the "strict": false, config temporarily, fix/improve some types, and then put "strict": false, back again. We also need help adding doc comments (taken from the readme).

[sindresorhus]

To prevent any duplicate work, I just want to make it clear that @vladfrangu is currently working on this issue :)

[sindresorhus]

@vladfrangu Have you had the chance to do some more work on it?

[vladfrangu]

I haven't really had a lot of free time recently, which sucks a lot, and I'm so sorry about that! I'll check out what needs to be done when I get back in around 2 weeks to get the project to compile with strict mode (on the latest TS version too). I'll keep you up to date as much as I can!

[sindresorhus]

Sounds good. Thank you :)

[sindresorhus]

This is still up for grabs.

[pmmmwh]

This is still up for grabs.

Hey! I can work on this issue next week. I guess a good first PR would be to make the source code strict mode compatible?

[sindresorhus]

I guess a good first PR would be to make the source code strict mode compatible?

Yes, just keep in mind that is harder than it looks. There have been multiple attempts already, which have improved the types a lot, but still not managed to make it 100% strict.

[sindresorhus]

Add doc comments to public (meaning exported) functions/types/interfaces. Borrow text from readme. This especially applies to the options and the main Got interface. Follow this style: sindresorhus/typescript-definition-style-guide#documentation

@pmmmwh I think ⬆️ is the only thing left to resolve this issue.

[pmmmwh]

Add doc comments to public (meaning exported) functions/types/interfaces. Borrow text from readme. This especially applies to the options and the main Got interface. Follow this style: sindresorhus/typescript-definition-style-guide#documentation

@pmmmwh I think ⬆️ is the only thing left to resolve this issue.

I'm starting to work on this. I'll ask if I hit any road blockers, but I don't think there will be much.

[sindresorhus]

@pmmmwh Still insterested in finishing this?

[pmmmwh]

@pmmmwh Still interested in finishing this?

Yes - sorry that I've been quite busy with other stuff for the past few months.

I've opened a draft PR (#1278) to track progress.

[issuehunt-app[bot]]

@sindresorhus has rewarded $162.00 to @pmmmwh. See it on IssueHunt

• :moneybag: Total deposit: $180.00
• :tada: Repository reward(0%): $0.00
• :wrench: Service fee(10%): $18.00