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
ws added EventListenerOptions and removed optional flag on callback #46794
ws added EventListenerOptions and removed optional flag on callback #46794
Conversation
@wilwade Thank you for submitting this PR! I see this is your first time submitting to DefinitelyTyped 👋 — I'm the local bot who will help you through the process of getting things through. This is a live comment which I will keep updated. 1 package in this PRCode ReviewsBecause you edited one package and updated the tests (👏), I can help you merge this PR once someone else signs off on it. Status
All of the items on the list are green. To merge, you need to post a comment including the string "Ready to merge" to bring in your changes. Diagnostic Information: What the bot saw about this PR{
"type": "info",
"now": "-",
"pr_number": 46794,
"author": "wilwade",
"owners": [
"loyd",
"elithrar",
"mlamp",
"TitaneBoy",
"orblazer",
"reduckted",
"teidesu",
"wojtkowiak"
],
"dangerLevel": "ScopedAndTested",
"headCommitAbbrOid": "ecea87a",
"headCommitOid": "ecea87a8ae3f48365b5b6fe575f8e80e2c661b06",
"mergeIsRequested": true,
"stalenessInDays": 0,
"lastPushDate": "2020-08-14T20:50:20.000Z",
"lastCommentDate": "2020-09-28T22:46:40.000Z",
"maintainerBlessed": true,
"reviewLink": "https://github.com/DefinitelyTyped/DefinitelyTyped/pull/46794/files",
"hasMergeConflict": false,
"authorIsOwner": false,
"isFirstContribution": true,
"popularityLevel": "Critical",
"newPackages": [],
"packages": [
"ws"
],
"files": [
{
"path": "types/ws/index.d.ts",
"kind": "definition",
"package": "ws"
},
{
"path": "types/ws/ws-tests.ts",
"kind": "test",
"package": "ws"
}
],
"hasDismissedReview": false,
"ciResult": "pass",
"lastReviewDate": "2020-09-28T18:30:52.000Z",
"reviewersWithStaleReviews": [],
"approvalFlags": 4,
"isChangesRequested": false
} |
🔔 @loyd @elithrar @mlamp @TitaneBoy @orblazer @reduckted @teidesu @wojtkowiak — please review this PR in the next few days. Be sure to explicitly select |
Inspecting the JavaScript source for this package found some properties that are not in the .d.ts files. ws (unpkg)was missing the following properties:
|
👋 Hi there! I’ve run some quick measurements against master and your PR. These metrics should help the humans reviewing this PR gauge whether it might negatively affect compile times or editor responsiveness for users who install these typings. Let’s review the numbers, shall we? Comparison details 📊
It looks like nothing changed too much. I won’t post performance data again unless it gets worse. |
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.
Personally, I might also add a test demonstrating that not passing a callback is an error.
@wilwade Everything looks good here. Great job! I am ready to merge this PR on your behalf. If you'd like that to happen, please post a comment saying:
and I'll merge this PR almost instantly. Thanks for helping out! ❤️ (@loyd, @elithrar, @mlamp, @TitaneBoy, @orblazer, @reduckted, @teidesu, @wojtkowiak: you can do this too.) |
Ready to merge |
I just published |
Fixing types around addEventListener for the ws package:
once
option websockets/ws#1754)Please fill in this template.
npm test
.)npm run lint package-name
(ortsc
if notslint.json
is present).Select one of these and delete the others:
If changing an existing definition:
tslint.json
containing{ "extends": "dtslint/dt.json" }
. If for reason the any rule need to be disabled, disable it for that line using// tslint:disable-next-line [ruleName]
and not for whole package so that the need for disabling can be reviewed.