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 typescript definitions #13

Open
wants to merge 4 commits into
base: latest
Choose a base branch
from

Conversation

forivall
Copy link
Contributor

The focus of this PR is to add type definitions for typescript. Minimum typescript version supported is 3.0.0 (as figgy pudding is very fancy)

This PR adds documentation for other and one extra test for this in forEach. These changes can be split into other PRs if you want to review them separately.

Copy link
Owner

@zkat zkat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I find it strange to include types but not include a test that makes sure they pass.

Conversely, I find myself feeling kind of annoyed at the idea of having to deal with these type definitions myself when changing things or adding features. Seeing as I don't use TS for anything else right now, I'm having feelings that this would end up just becoming a maintenance burden for me once your PR lands.

@forivall
Copy link
Contributor Author

forivall commented Sep 13, 2018 via email

@nickytonline
Copy link

nickytonline commented Jul 9, 2019

You can use the tsd package to test the types. See fregante/intervalometer#1 for an example. You could put them in DefinitelyTyped if you feel they'll become a burden.

@nickytonline
Copy link

Having said that, I'm sure people would update them for you in your own repo. Another option, if you're open to it, is to just convert the project to TypeScript.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants