-
Notifications
You must be signed in to change notification settings - Fork 29.8k
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
doc: change eventName type annotations #17666
Conversation
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.
LGTM
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.
🎉
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.
Thanks for helping make our documentation better!
Now that #17440 landed, this will need to be rebased and |
Sure, np! Can take care of that today. |
If I remember correctly @mscdex was not in favor of this due to numbers being "valid" or something like that. |
@lpinca I mean, that's sort of what I brought up in the original thread. Right now you can enter absolutely anything and it'll just be coerced to a string (if it's not a Symbol). |
Yes, I have nothing against this change, I'm actually +1 just wanted to get @mscdex attention as they might be interested/concerned. |
Change type annotations for eventName in events API doc from {any} to {string|symbol} to be consistent with doc changes made in nodejs#17440. Fixes: nodejs#17657
e74cba2
to
431991c
Compare
Landed in b2432a7. Thanks for the contribution @aprilwebster and congrats on becoming a Contributor!! 🎉 |
Change type annotations for eventName in events API doc from {any} to {string|symbol}. PR-URL: #17666 Fixes: #17657 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Jon Moss <[email protected]> Reviewed-By: Timothy Gu <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Evan Lucas <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Anatoli Papirovski <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
Thanks @apapirovski!! Hopefully I can make a few more contributions in the new year. Happy holidays! |
Change type annotations for eventName in events API doc from {any} to {string|symbol}. PR-URL: #17666 Fixes: #17657 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Jon Moss <[email protected]> Reviewed-By: Timothy Gu <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Evan Lucas <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Anatoli Papirovski <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
Change type annotations for eventName in events API doc from {any} to {string|symbol}. PR-URL: #17666 Fixes: #17657 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Jon Moss <[email protected]> Reviewed-By: Timothy Gu <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Evan Lucas <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Anatoli Papirovski <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
Change type annotations for eventName in events API doc from {any} to
{string|symbol} to be consistent with doc changes made in #17440.
Fixes: #17657
Checklist
Affected core subsystem(s)
doc