feat(APIGuildScheduledEvent): add more precise types for stage instance/voice/external events #278
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
…ce/voice/external events This commit turns `APIGuildScheduledEvent` into a union of `APIStageInstanceGuildScheduledEvent`, `APIVoiceGuildScheduledEvent`, and `APIExternalGuildScheduledEvent`, which each has more precise types according to [the docs][1]. This commit also fixes a bug as previously `APIGuildScheduledEvent#entity_metadata` was not nullable, even though it should be. [1]: https://discord.com/developers/docs/resources/guild-scheduled-event#guild-scheduled-event-object-field-requirements-by-entity-type
kyranet
approved these changes
Dec 26, 2021
iCrawl
approved these changes
Dec 26, 2021
vladfrangu
approved these changes
Dec 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:
This PR turns
APIGuildScheduledEventinto a union ofAPIStageInstanceGuildScheduledEvent,APIVoiceGuildScheduledEvent, andAPIExternalGuildScheduledEvent, which each has more precise types according to the docs.This PR also fixes a bug as previously
APIGuildScheduledEvent#entity_metadatawas not nullable, even though it should be.Reference Discord API Docs PRs or commits:
Technically,
entity_metadataisn’t alwaysnullfor stage instance events (see discord/discord-api-docs#4198) and contains aspeaker_idsfield, but that isn’t documented anymore.From this comment:
I decided to make
entity_metadatanullfor stage instance events as that is what the documentation states.