docs: add missing ApplicationCommandPermissionsUpdateData#11415
docs: add missing ApplicationCommandPermissionsUpdateData#11415
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub. 2 Skipped Deployments
|
There was a problem hiding this comment.
Pull request overview
Adds missing JSDoc for ApplicationCommandPermissionsUpdateData, aligning the documented event payload with the existing TypeScript typing and fixing a regression introduced in #10666.
Changes:
- Introduces a JSDoc
@typedefforApplicationCommandPermissionsUpdateDatain the gateway handler. - Documents the payload fields (
permissions,id,guildId,applicationId) used in theapplicationCommandPermissionsUpdateevent.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
packages/discord.js/src/client/websocket/handlers/APPLICATION_COMMAND_PERMISSIONS_UPDATE.js
Outdated
Show resolved
Hide resolved
…COMMAND_PERMISSIONS_UPDATE.js Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
📝 WalkthroughWalkthroughA JSDoc typedef Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In
`@packages/discord.js/src/client/websocket/handlers/APPLICATION_COMMAND_PERMISSIONS_UPDATE.js`:
- Around line 6-14: Update the JSDoc comment for the
ApplicationCommandPermissionsUpdateData typedef: change the phrase "a
application command permissions update" to correct grammar "an application
command permissions update" in the block comment above
ApplicationCommandPermissionsUpdateData so the description reads properly.
📜 Review details
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
packages/discord.js/src/client/websocket/handlers/APPLICATION_COMMAND_PERMISSIONS_UPDATE.js
🔇 Additional comments (1)
packages/discord.js/src/client/websocket/handlers/APPLICATION_COMMAND_PERMISSIONS_UPDATE.js (1)
9-14: LGTM!The typedef correctly documents the structure of the emitted event data, with properties matching the object at lines 24-29. The type references (
ApplicationCommandPermissions[],Snowflake) are standard Discord.js types.
✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.
ApplicationCommandPermissionsUpdateDatais the type being used for the event parameter, which is correctly typed in typescript land, but doesn't have a corresponding JSDoc entry, meaning it doesn't have descriptions.Regression from #10666