Improve the TypeScript types

[sindresorhus]

I think the types could still be improved.

• Would be good to use unknown instead of any here:

  conf/index.d.ts

  Line 210 in bb24cfe

  declare class Conf<T = any> implements Iterable<[keyof T, T[keyof T]]> {

  But it causes error on a valid usage:

   index.test-d.ts:123:13
     ✖  123:13  Argument of type "debug phase" is not assignable to parameter of type never.
  

• You cannot use dot-paths with a typed store: config.set('foo.bar', true);. We need to find a way to support that. Could possibly add support for config.set(['foo', 'bar'], true).
• Reduce duplication if you use both a typed store and the defaults option. Maybe using the const keyword.
• Could we make the types even stricter?
• Expose the type of the schema option, so it's easier to define it as a variable before passing it. Currently, you would have to do const schema = {[Key in keyof TypedStore]: Conf.Schema} = {…};.

  conf/index.d.ts

  Line 50 in bb24cfe

  readonly schema?: {[P in keyof T]: Schema};

• Maybe rename the current Schema type to something clearer like SchemaValue, SchemaOptionValue? Need some naming suggestions.

I'm open to other ideas on how to improve the types.

---

IssueHunt Summary

superjo149 has been rewarded.

Backers (Total: $80.00)

• issuehunt ($80.00)

Submitted pull Requests

• #96 refactor: change source code to typescript
• #104 Refactor/typescript

---

Tips

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

[issuehunt-oss]

@issuehunt has funded $80.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.

[brunolemos]

I highly recommend moving from index.js to index.ts for automatic type generation.

[sindresorhus]

Yeah, I'm happy to move to TypeScript if anyone wants to do the work.

Here's the config I use:

• https://github.com/sindresorhus/p-queue/blob/144d0ad54c9940d8b53359bd4566be89d8437df5/tsconfig.json
• https://github.com/sindresorhus/p-queue/blob/144d0ad54c9940d8b53359bd4566be89d8437df5/package.json#L12-L15
• https://github.com/sindresorhus/p-queue/blob/144d0ad54c9940d8b53359bd4566be89d8437df5/package.json#L67-L87

[satyarohith]

I would like to work on this.

[sindresorhus]

For anyone that wants to work on this, see the initial attempt and feedback in #96. You can start from there.

[sneljo1]

Accidentally ran into this issue yesterday. Might take a crack at it. :)

[issuehunt-oss]

@sindresorhus has rewarded $72.00 to @superjo149. See it on IssueHunt

• 💰 Total deposit: $80.00
• 🎉 Repository reward(0%): $0.00
• 🔧 Service fee(10%): $8.00