Add type declaration for typescript users #63
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅ |
|
I have read the CLA Document and I hereby sign the CLA |
|
Nice! thanks! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi @zh217, thanks for the amazing work! I thought it might be a "low hanging fruit" to add typescript support, hence this PR.
From the library consumers' point view, this change would allow them to import the library in TypeScript. The library is currently not usable by typescript out-of-the-box due to lack of typing files.
From the maintainer's (your) point view, this change implies the added liability for you to keep the documentation markdown (all languages) and the
index.d.tstyping file in sync. An alternative approach is to combineindex.js+index.d.tsinto a singleindex.tsfile, but that is a bigger change and requires new toolchain.I'm happy to make small adjustments based on your needs. It is also ok if you want to dismiss this PR. It literally took me 5 minutes.