-
-
Notifications
You must be signed in to change notification settings - Fork 124
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 #138
Conversation
Never mind. According to Typescript's documentation, if the package is not written in Typescript, it's preferable to add the type definitions to the DefinitelyTyped repo. |
Actually, DefinitelyTyped's recommendation is:
So I'm reopening this PR to add the definitions here. |
LGTM, though I'm not a Typescript user. You might want to add a note to the readme to the effect that any PRs should ideally include updated Typescript definitions if necessary, in addition to passing tests. |
I'm going to try to figure out if there's an easy way to write tests for this. Then we could include that in the testing workflow. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great, sounds good to me. Feel free to merge when you're happy!
I haven't added any tooling for this test. To check it, Typescript needs to be installed. Then run: tsc --noEmit ./tests/test.ts
I haven't added any tooling for actually running or automating the tests. To run it, Typescript would need to be installed, and I don't want to deal with that now. To run it manually, install Typescript (either locally or globally), and then run:
|
No description provided.