docs: add new typedef to properly doc InteractionReplyOptions #5632
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
iCrawl
approved these changes
May 22, 2021
kyranet
approved these changes
May 22, 2021
vladfrangu
approved these changes
May 23, 2021
SpaceEEC
approved these changes
May 26, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please describe the changes this PR makes and why it should be merged:
ℹ️ Preview: https://preview-5632.netlify.app
Currently,
InteractionReplyOptionsextends jsdoc ofWebhookMessageOptionswhich results in a slightly wrong documentation as the latter one has some extra fields. The reason @vaporox gave for not making a new typedef from scratch for it was "code duplication". Which is correct becauseMessageOptions,WebhookMessageOptions, andReplyMessageOptionsall have a lot of common fields and these fields are documented for each of them.This PR adds a new typedef
BaseMessageOptionsthat contains fields that are common among the above typedefs. The above mentioned typedefs now extend this new typedef, making documention correct while keeping the code duplication at minimum.Status and versioning classification: