Add typescript types, update API doc #1022
Open
Conversation
This file contains 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
…his package. I elected to create the Typescript types by creating ordinary .ts files and compiling them. My reasoning is that more TS developers are familiar with regular .ts rather than the extra syntax in .d.ts files. I also updated the API documentation to fix some wording and typos, update the API signatures, and create a table of contents organized by object name. I also updated the examples to use more modern JS and variable names based on the class names. Signed-off-by: Andre Asselin <andre.asselin@primerica.com>
asselin
force-pushed
the
feature/typescript-types
branch
from
0eab1ba to
adaaa3b
Compare
|
Force pushed the branch to add signoff message to the commit (also squashed all commits into 1) |
|
@bimalkjha Here's the PR to add Typescript types. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #1019
This PR updates the Typescript types from @DefinitelyTyped and adds them to this package. I also updated the API Documentation to align with the current implementation.
I elected to create the Typescript types by creating ordinary .ts files and compiling them. My reasoning is that more TS developers are familiar with regular .ts rather than the extra syntax in .d.ts files.
I also updated the API documentation to fix some wording and typos, update the API signatures, and create a table of contents organized by object name. I also updated the examples to use more modern JS and variable names based on the class names.
Please let me know if this is acceptable for merging.
Thanks!
DCO Signed-off-by: Andre Asselin andre.asselin@primerica.com