Add typings

Question

Add typings

Jytesh opened this issue 3 years ago · comments

Jitesh Dhakshinamoorthy commented 3 years ago

Will enable autocompletion in supported text editors/IDEs.
Previous discussion in #22
To prevent definitions going out of sync we should either include some sort of test to validate the definitions or alternatively they be generated from our source (annotated comments?).

From #25

Better to add the typings from PR: #30 instead of translating the whole thing to typescript (IMO)

Jitesh Dhakshinamoorthy · Answer 1 · Tue Apr 20 2021 22:45:08 GMT+0800 (China Standard Time)

https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/keyv/index.d.ts

This is also a good reference

Kiko Beats · Answer 2 · Tue Apr 20 2021 22:54:34 GMT+0800 (China Standard Time)

I think keeping types at DefinitelyTyped repository it's great because it allows any member of the community to edit it without releasing a new keyv version.

Also I think that's a good practice inside TypeScript community, e.g.,
https://github.com/browserless/chrome/blob/master/base/Dockerfile#L85

Jitesh Dhakshinamoorthy · Answer 3 · Wed Apr 21 2021 01:30:34 GMT+0800 (China Standard Time)

Alright then! Any idea how to test those, and have a notif or something when the typings go out of sync?

Jitesh Dhakshinamoorthy · Answer 4 · Wed Apr 21 2021 01:34:18 GMT+0800 (China Standard Time)

And I think the types at @types/keyv only provide types for keyv by default, do we need to enable/configure something to make @keyvhq/keyv use the same typings

Jitesh Dhakshinamoorthy · Answer 5 · Sat Jun 19 2021 13:46:03 GMT+0800 (China Standard Time)

And I think the types at @types/keyv only provide types for keyv by default, do we need to enable/configure something to make @keyvhq/keyv use the same typings

@Kikobeats ^^