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

fix(api-extractor): link class in docs if interface merging happened #10217

Merged
merged 2 commits into from
Apr 16, 2024

Conversation

Qjuh
Copy link
Contributor

@Qjuh Qjuh commented Apr 15, 2024

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

Fixes parameter types linking to the the class instead of the (merged) interface for cases where interface merging happened. (e.g. GuildMember, User, DMChannel, TextChannel, Webhook, ...)

Status and versioning classification:

  • This PR only includes non-code changes, like changes to documentation, README, etc.

@Qjuh Qjuh requested a review from iCrawl as a code owner April 15, 2024 19:23
Copy link

vercel bot commented Apr 15, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

2 Ignored Deployments
Name Status Preview Comments Updated (UTC)
discord-js ⬜️ Ignored (Inspect) Visit Preview Apr 16, 2024 0:34am
discord-js-guide ⬜️ Ignored (Inspect) Visit Preview Apr 16, 2024 0:34am

Copy link
Member

@vladfrangu vladfrangu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If it works LGTM

@Qjuh
Copy link
Contributor Author

Qjuh commented Apr 16, 2024

It works for js packages with manual ts typings (so just mainlib atm) under the assumption that the class declaration is always the last of the merged declarations. Which currently is the case. I‘m not sure if making it more complicated by finding a class declaration and if none exists falling back to other types of declaration would be beneficial here.

@iCrawl iCrawl merged commit c6721d9 into discordjs:main Apr 16, 2024
6 checks passed
@Qjuh Qjuh deleted the fix/docs-event-type branch April 29, 2024 06:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants