Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add typings #4

Closed
Jytesh opened this issue Apr 20, 2021 · 5 comments · Fixed by #60
Closed

Add typings #4

Jytesh opened this issue Apr 20, 2021 · 5 comments · Fixed by #60
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@Jytesh
Copy link
Collaborator

Jytesh commented Apr 20, 2021

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)

@Jytesh Jytesh self-assigned this Apr 20, 2021
@Jytesh Jytesh added the enhancement New feature or request label Apr 20, 2021
@Jytesh Jytesh added this to the v1.0.0 milestone Apr 20, 2021
@Jytesh
Copy link
Collaborator Author

Jytesh commented Apr 20, 2021

@Kikobeats
Copy link
Member

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

@Jytesh
Copy link
Collaborator Author

Jytesh commented Apr 20, 2021

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

@Jytesh
Copy link
Collaborator Author

Jytesh commented Apr 20, 2021

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

@Jytesh
Copy link
Collaborator Author

Jytesh commented Jun 19, 2021

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 ^^

@Jytesh Jytesh mentioned this issue Oct 2, 2021
@Jytesh Jytesh linked a pull request Oct 2, 2021 that will close this issue
@Jytesh Jytesh closed this as completed in #60 Oct 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants