Skip to content

docs: add missing ApplicationCommandPermissionsUpdateData#11415

Open
almeidx wants to merge 2 commits intomainfrom
docs/missing-app-permissions-doc
Open

docs: add missing ApplicationCommandPermissionsUpdateData#11415
almeidx wants to merge 2 commits intomainfrom
docs/missing-app-permissions-doc

Conversation

@almeidx
Copy link
Member

@almeidx almeidx commented Feb 4, 2026

ApplicationCommandPermissionsUpdateData is 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

@vercel
Copy link

vercel bot commented Feb 4, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

2 Skipped Deployments
Project Deployment Actions Updated (UTC)
discord-js Skipped Skipped Feb 4, 2026 11:44am
discord-js-guide Skipped Skipped Feb 4, 2026 11:44am

Request Review

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 @typedef for ApplicationCommandPermissionsUpdateData in the gateway handler.
  • Documents the payload fields (permissions, id, guildId, applicationId) used in the applicationCommandPermissionsUpdate event.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

…COMMAND_PERMISSIONS_UPDATE.js

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@coderabbitai
Copy link

coderabbitai bot commented Feb 4, 2026

📝 Walkthrough

Walkthrough

A JSDoc typedef ApplicationCommandPermissionsUpdateData was added to document the structure of application command permissions update events, including properties for permissions array, ID, guild ID, and application ID.

Changes

Cohort / File(s) Summary
JSDoc Typedef Addition
packages/discord.js/src/client/websocket/handlers/APPLICATION_COMMAND_PERMISSIONS_UPDATE.js
Added JSDoc typedef documenting the shape of application command permissions update data with properties: permissions, id, guildId, and applicationId.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main change: adding missing JSDoc documentation for ApplicationCommandPermissionsUpdateData.
Description check ✅ Passed The description directly addresses the changeset by explaining what type was added, why it was needed, and referencing the regression source.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/missing-app-permissions-doc

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between c71228a and 30d6020.

📒 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.

@vercel vercel bot temporarily deployed to Preview – discord-js February 4, 2026 11:44 Inactive
@vercel vercel bot temporarily deployed to Preview – discord-js-guide February 4, 2026 11:44 Inactive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

3 participants