Skip to content
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

docs(InteractionResponses): Document missing properties #6178

Merged
merged 4 commits into from
Jul 28, 2021
Merged

docs(InteractionResponses): Document missing properties #6178

merged 4 commits into from
Jul 28, 2021

Conversation

Jiralite
Copy link
Member

@Jiralite Jiralite commented Jul 23, 2021

Please describe the changes this PR makes and why it should be merged:
Hey!

InteractionResponses did not document a few fetchReply properties to the methods, so I've gone ahead and added those in.

The documentation for the type definition InteractionDeferUpdateOptions was completely missing, so I've added that in too!

I also noticed that the .update() method documented WebhookEditMessageOptions to be sent across. This didn't include the fetchReply property, but I did see an interesting InteractionUpdateOptions type that wasn't being used anywhere other than itself being defined. It looks a bit wrong though, because it extended WebhookMessageOptions which allowed properties like tts to be sent through when it wouldn't do anything, so I adjusted this to extend WebhookEditMessageOptions instead so I applied the fix from #6162 after reading through it. My attempted fix of this changed content to options here, so I might as well leave that in for some consistency with the other methods.

This should resolve #6157!

Please check through the wording and typings and stuff and let me know if anything seems amiss!

Status and versioning classification:

  • Code changes have been tested against the Discord API, or there are no code changes
  • I know how to update typings and have done so, or typings don't need updating

fix(InteractionResponses): Add missing type definition for `InteractionDeferUpdateOptions`

types: Correct update method typings

types(index): Add back allowed parameters

docs(InteractionResponses): Add missing `fetchReply` property
@iCrawl iCrawl added this to the Version 13 milestone Jul 24, 2021
@Jiralite Jiralite changed the title fix(InteractionResponses): Document missing properties and correct typings fix(InteractionResponses): Document missing properties Jul 24, 2021
@Jiralite Jiralite changed the title fix(InteractionResponses): Document missing properties docs(InteractionResponses): Document missing properties Jul 24, 2021
@Jiralite Jiralite requested a review from vladfrangu July 24, 2021 18:11
@Jiralite Jiralite requested a review from SpaceEEC July 27, 2021 11:52
@iCrawl iCrawl merged commit 5e433b5 into discordjs:master Jul 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Undocumented fetchReply option across the Interaction methods
5 participants