feat: add ts typedefs #32
Merged
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
Gozala
force-pushed
the
feat/ts-typedefs
branch
from
4823e18 to
da08a98
Compare
achingbrain
requested changes
Dec 19, 2020
There was a problem hiding this comment.
This needs the type checker run over the tests to ensure the types are as intended, otherwise releasing future changes will be very error prone.
This should also go out as a major to avoid breaking projects that have types, use this module and suddenly discover the types are not quite as they expected.
|
@Gozala ping |
Gozala
commented
Jan 20, 2021
|
Addressed review comments & is ready for another pass |
hugomrdias
reviewed
Jan 23, 2021
Co-authored-by: Alex Potsides <alex@achingbrain.net>
Gozala
commented
Jan 26, 2021
|
I'll need to deprecate the types in @types/err-code |
|
PR created DefinitelyTyped/DefinitelyTyped#52518 |
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.
Adds typedefs so that users of this library can get those out of the box. I have considered adding them via jsdoc systax as per #31, however given all the overloads used in the implementation it's impossible to type those in jsdoc syntax without additional type magic &
@ts-ignorecomments.For this reasons and the minimal surface of this lib, I think it's more practical to just have
index.d.tsfile instead.