-
-
Notifications
You must be signed in to change notification settings - Fork 24
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
feature(types): add type definitions #51
Conversation
CI failure is due to Appveyor and Node 5, this is not caused by this PR. |
Bump: @isaacs @bcoe @profnandaa |
cd56ac0
to
142ffd9
Compare
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.
I'd prefer that we deal with the major issues first (for moving this package forward), before we come to types
.
@profnandaa Which major issues? |
Yes, the |
@demurgos is this still something you'd like to land, would love to work with you to get some of the work you've done in the past over the finish line. |
I had less time for open-source at the start of the year but with the release of Node 12, I am catching up and am definitely OK with finishing what was started 🙂 I'll be on the |
bump, this would still be pretty cool to land -- or could we land it on DefinitelyTyped? |
👍 |
This will be superceded by v4 very shortly. There are types on |
Why
See my blog post on the benefits of type definitions.
signal-exit
is extremely popular since it's used as a dependency of most code coverage tools. Writing down the public API in a strict format is a good way to specify the contracts of the API.This PR is part of the effort to improve code coverage tools for Node as part of node-tooling group. I am going over the dependencies and checking them.
What
Add type definitions for
signal-exit
and link them inpackage.json
. From a semver point of view this is a feature. Even if it's mostly there for documentation purposes, it enables TS consumers to types for this lib.