docs(WebhookClient): Make constructor a union #8370
Merged
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
github-actions
bot
requested review from
iCrawl,
kyranet,
SpaceEEC and
vladfrangu
Co-authored-by: muchnameless <12682826+muchnameless@users.noreply.github.com>
iCrawl
approved these changes
Jul 27, 2022
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:
WebhookClientDatais now a union of two possible objects rather than one object containing all the properties. This reflects the typings exactly and also introducesWebhookClientDataIdWithToken&WebhookClientDataURLin the documentation which also reflects the typings exactly.This also fixes an issue where the return type of the top-level function
parseWebhookURL()documented the id as astringinstead of aSnowflake.Status and versioning classification: