Improve invite typings #958
Closed
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
eritbh
commented
May 29, 2020
| createChannelInvite( | ||
| channelID: string, | ||
| options?: { maxAge?: number; maxUses?: number; temporary?: boolean; unique?: boolean }, | ||
| reason?: string | ||
| ): Promise<ChannelInvite>; | ||
| ): Promise<GuildInviteWithoutMetadata>; |
There was a problem hiding this comment.
Discord docs don't say that invite metadata is returned on the create invite endpoint, but the previous implementation did use an interface that included it. Is the documentation accurate, or is the metadata actually returned in this case and the Discord docs are wrong? Ref https://discord.com/developers/docs/resources/channel#create-channel-invite
(this applies to all other createInvite methods on other structures)
|
CC'ing @DonovanDMC since they were the last one to change these typings. LMK if anything looks wrong. |
|
Implemented in #993 with proper class declaration after a discussion in the channel |
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.
Rather than letting invites be typed as a mess of interfaces, the
Inviteclass is actually typed as a class now. This class stores metadata properties asnullin situations where metadata is not returned by the API, which is now reflected accurately. Additional types were added for specifying private invites and guild channel invites, both with and without the additional metadata.In situations where an invite is possibly a guild or private invite, its type can now be deduced via
invite.guildbeing truthy, rather than having to use'guild' in inviteto check. This is a side effect of the way TS handles the distinction between omitted properties and properties withundefinedas a value.I'm unsure of a couple relevant API details; will leave comments asking about them.