Add types declaration file with unit tests #267
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
2 similar comments
Rob--W
requested changes
Sep 9, 2020
Owner
Rob--W
left a comment
Rob--W
left a comment
There was a problem hiding this comment.
The unit test in its current form does not offer any verification on the correctness of the Typescript definition.
A way to verify the correctness is to use the type definition with the existing test files (and check that there is no error), and as a smoke test also check whether a meaningful error is produced when an incorrect API is used.
I don't have experience with using it, but it seems that the typescript-eslint package may offer what we need.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Resolves #264. Let me know if there are any issues. I'm not familiar with Mocha and Chai so let me know if the test file needs any improvement (it all works when I run the test command).