René's URL Explorer Experiment


Title: intellisense for JSDocs on function overloads without needing to duplicate the JSDoc · Issue #51005 · microsoft/TypeScript · GitHub

Open Graph Title: intellisense for JSDocs on function overloads without needing to duplicate the JSDoc · Issue #51005 · microsoft/TypeScript

X Title: intellisense for JSDocs on function overloads without needing to duplicate the JSDoc · Issue #51005 · microsoft/TypeScript

Description: Suggestion 🔍 Search Terms intellisense for JSDocs on function overloads without needing to duplicate the JSDoc auto complete JSDocs function overloads ✅ Viability Checklist My suggestion meets these guidelines: This wouldn't be a breakin...

Open Graph Description: Suggestion 🔍 Search Terms intellisense for JSDocs on function overloads without needing to duplicate the JSDoc auto complete JSDocs function overloads ✅ Viability Checklist My suggestion meets thes...

X Description: Suggestion 🔍 Search Terms intellisense for JSDocs on function overloads without needing to duplicate the JSDoc auto complete JSDocs function overloads ✅ Viability Checklist My suggestion meets thes...

Opengraph URL: https://github.com/microsoft/TypeScript/issues/51005

X: @github

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"intellisense for JSDocs on function overloads without needing to duplicate the JSDoc","articleBody":"# Suggestion\r\n\r\n## 🔍 Search Terms\r\n\r\n- intellisense for JSDocs on function overloads without needing to duplicate the JSDoc\r\n- auto complete\r\n- JSDocs\r\n- function overloads\r\n\r\n## ✅ Viability Checklist\r\n\r\n\u003c!--\r\n   Suggestions that don't meet all these criteria are very, very unlikely to be accepted.\r\n   We always recommend reviewing the TypeScript design goals before investing time writing\r\n   a proposal for ideas outside the scope of the project.\r\n-->\r\nMy suggestion meets these guidelines:\r\n\r\n* [x] This wouldn't be a breaking change in existing TypeScript/JavaScript code\r\n* [x] This wouldn't change the runtime behavior of existing JavaScript code\r\n* [x] This could be implemented without emitting different JS based on the types of the expressions\r\n* [x] This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, new syntax sugar for JS, etc.)\r\n* [x] This feature would agree with the rest of [TypeScript's Design Goals](https://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals).\r\n\r\n## ⭐ Suggestion\r\n\r\nWhen you have a really long JSDoc that describes a function (say 10+ lines) and you need 3~4 function overloads for that function. The only way to properly have the JSDocs show up on all overload cases when you actually import and use the function is to duplicate the JSDocs for each single function overload...\r\n\r\nFR: We need VSCode intellisense for our JSDocs to **show up on ALL function overloads** _without_ needing to duplicate the JSDocs on every overload.\r\n\r\n## 📃 Motivating Example\r\n\r\nHere is a very common example I use countless of times throughout my code where an object that's potentially `undefined` is parsed in a function, but when we know the payload is not undefined we want to make sure the return type is also not.\r\n\r\n```ts\r\ntype Person = { firstName: string; lastName: string }\r\ntype PersonParsed = { fullName: string }\r\n\r\nexport function parsePerson(person: Person): PersonParsed\r\nexport function parsePerson(person: undefined): undefined\r\nexport function parsePerson(person: Person | undefined): PersonParsed | undefined\r\nexport function parsePerson(person?: Person): PersonParsed | undefined {\r\n  // ... implementation\r\n}\r\n```\r\n\r\nA perfect use-case for function overloads! But then comes your detailed JSDoc and it will look like this:\r\n\r\n```ts\r\ntype Person = { firstName: string; lastName: string }\r\ntype PersonParsed = { fullName: string }\r\n\r\n/**\r\n * Here is a very long JSDoc\r\n *\r\n * Maybe it describes what the function can do / when it should be used\r\n * - Maybe it has\r\n * - some bullet lists\r\n *\r\n * @see https://some-related-documentation...\r\n * @example\r\n * ```js\r\n * // some usage examples:\r\n * const { fullname } = parsePerson(person) || {}\r\n * console.log(`fullname → `, fullname)\r\n * ```\r\n */\r\nexport function parsePerson(person: Person): PersonParsed\r\n/**\r\n * Here is a very long JSDoc\r\n *\r\n * Maybe it describes what the function can do / when it should be used\r\n * - Maybe it has\r\n * - some bullet lists\r\n *\r\n * @see https://some-related-documentation...\r\n * @example\r\n * ```js\r\n * // some usage examples:\r\n * const { fullname } = parsePerson(person) || {}\r\n * console.log(`fullname → `, fullname)\r\n * ```\r\n */\r\nexport function parsePerson(person: undefined): undefined\r\n/**\r\n * Here is a very long JSDoc\r\n *\r\n * Maybe it describes what the function can do / when it should be used\r\n * - Maybe it has\r\n * - some bullet lists\r\n *\r\n * @see https://some-related-documentation...\r\n * @example\r\n * ```js\r\n * // some usage examples:\r\n * const { fullname } = parsePerson(person) || {}\r\n * console.log(`fullname → `, fullname)\r\n * ```\r\n */\r\nexport function parsePerson(person: Person | undefined): PersonParsed | undefined\r\n/**\r\n * Here is a very long JSDoc\r\n *\r\n * Maybe it describes what the function can do / when it should be used\r\n * - Maybe it has\r\n * - some bullet lists\r\n *\r\n * @see https://some-related-documentation...\r\n * @example\r\n * ```js\r\n * // some usage examples:\r\n * const { fullname } = parsePerson(person) || {}\r\n * console.log(`fullname → `, fullname)\r\n * ```\r\n */\r\nexport function parsePerson(person?: Person): PersonParsed | undefined {\r\n  // ... implementation\r\n}\r\n```\r\n\r\n## 💻 Use Cases\r\n\r\nUse case explained in the previous section.\r\n\r\n### Conclusion\r\n\r\nWe need VSCode intellisense for our JSDocs to **show up on ALL function overloads** _without_ needing to duplicate the JSDocs on every overload.\r\n\r\n","author":{"url":"https://github.com/mesqueeb","@type":"Person","name":"mesqueeb"},"datePublished":"2022-09-30T04:03:41Z","url":"https://github.com/microsoft/TypeScript/issues/51005"}

react-profiling0
react-import-mapreact,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322
route-pattern/_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format)
route-controllervoltron_issues_fragments
route-actionissue_layout
fetch-noncev2:81b02d31-243a-7693-3832-f9de21a770d3
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-idE7AC:117C62:2555024:31D3B8F:6B01A456
html-safe-nonce12d3a5a12795fd8dbce15d625dadfb6f5a2aab87548272073c7ab999264bde5b
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJFN0FDOjExN0M2MjoyNTU1MDI0OjMxRDNCOEY6NkIwMUE0NTYiLCJ2aXNpdG9yX2lkIjoiMjExODkzNTY3MjE5MzY1NTg5NCIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9
visitor-hmacf25b917eb3174741df39a6b05fedad207297283daa5a86bad991d427227779d3
hovercard-subject-tagissue:1391789702
github-keyboard-shortcutsrepository,issues,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///voltron/issues_fragments/issue_layout
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/microsoft/TypeScript/51005/issue_layout
twitter:imagehttps://opengraph.githubassets.com/78d56029b0353e0f59c3b093c7e7bd1d12d15811d40c41b3456acce6931798d3/microsoft/TypeScript/issues/51005
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/78d56029b0353e0f59c3b093c7e7bd1d12d15811d40c41b3456acce6931798d3/microsoft/TypeScript/issues/51005
og:image:altSuggestion 🔍 Search Terms intellisense for JSDocs on function overloads without needing to duplicate the JSDoc auto complete JSDocs function overloads ✅ Viability Checklist My suggestion meets thes...
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernamemesqueeb
hostnamegithub.com
expected-hostnamegithub.com
Nonecc5dfdd32f62ebd3223cab3af3aa2b268d3605218237326a48a99d1efd89495c
turbo-cache-controlno-preview
go-importgithub.com/microsoft/TypeScript git https://github.com/microsoft/TypeScript.git
octolytics-dimension-user_id6154722
octolytics-dimension-user_loginmicrosoft
octolytics-dimension-repository_id20929025
octolytics-dimension-repository_nwomicrosoft/TypeScript
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id20929025
octolytics-dimension-repository_network_root_nwomicrosoft/TypeScript
turbo-body-classeslogged-out env-production page-responsive
disable-turbofalse
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release8c77c9e8439031ad54c75a250694842892f693e1
ui-targetfull
theme-color#1e2327
color-schemelight dark
react-app-nameissues

Links:

Skip to contenthttps://github.com/microsoft/TypeScript/issues/51005#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fmicrosoft%2FTypeScript%2Fissues%2F51005
GitHubRepository hosting, code review, and collaborationhttps://github.com/platform
CopilotAI coding agent for tasks, projects, and automated workhttps://github.com/features/copilot
ActionsCI/CD and automationhttps://github.com/features/actions
Code QualityQuality analysis, fixes, and enforcementhttps://github.com/features/code-quality
CodespacesCloud development environmentshttps://github.com/features/codespaces
Code SecurityVulnerability detection and remediationhttps://github.com/security/advanced-security/code-security
Secret ProtectionSecret scanning and leak preventionhttps://github.com/security/advanced-security/secret-protection
All Featureshttps://github.com/features
Documentationhttps://docs.github.com/en
Traininghttps://learn.github.com/skills
Certificationshttps://learn.github.com/credentials
Build with Copilothttps://github.com/features/ai
Customize Copilothttps://docs.github.com/en/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview
Integrationshttps://github.com/marketplace
Trending reposhttps://github.com/trending
GitHub Sponsorshttps://github.com/open-source/sponsors
Developer articleshttps://github.com/resources/articles
ChangelogYour source for the latest features, improvements, and fixes across GitHub products, all in one place.https://github.blog/changelog/
Enterpriseshttps://github.com/enterprise
Teamhttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
See all industrieshttps://github.com/solutions/industry
Why GitHubhttps://github.com/why-github
Customer Storieshttps://github.com/customer-stories
Business insightshttps://github.com/solutions/executive-insights
Trust Centerhttps://github.com/trust-center
GitHub Advanced SecurityEnterprise-grade code securityhttps://github.com/security/advanced-security
Copilot for businessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/enterprise/premium-support
Documentationhttps://docs.github.com/en
Resource centerhttps://github.com/resources
Bloghttps://github.blog/
Events & webinarshttps://github.com/resources/events
Community Forumhttps://github.com/orgs/community/discussions
Customer Storieshttps://github.com/customer-stories
Integrationshttps://github.com/marketplace
Customer supporthttps://help.github.com/
Traininghttps://learn.github.com/skills
GitHub Statushttps://www.githubstatus.com/
Abouthttps://github.com/about
Partnershttps://github.com/partners
Changeloghttps://github.blog/changelog/
GitHub UniverseThe event for developers, by developers — talks, workshops, and what’s next for GitHub.https://githubuniverse.com/
Pricinghttps://github.com/pricing
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fmicrosoft%2FTypeScript%2Fissues%2F51005
Sign uphttps://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fvoltron%2Fissues_fragments%2Fissue_layout&source=header-repo&source_repo=microsoft%2FTypeScript
Reloadhttps://github.com/microsoft/TypeScript/issues/51005
Reloadhttps://github.com/microsoft/TypeScript/issues/51005
Reloadhttps://github.com/microsoft/TypeScript/issues/51005
microsofthttps://github.com/microsoft
TypeScripthttps://github.com/microsoft/TypeScript
Codehttps://github.com/microsoft/TypeScript
Issues5k (5k)https://github.com/microsoft/TypeScript/issues
Pull requests312 (312)https://github.com/microsoft/TypeScript/pulls
Actionshttps://github.com/microsoft/TypeScript/actions
Projectshttps://github.com/microsoft/TypeScript/projects
Wikihttps://github.com/microsoft/TypeScript/wiki
Security and qualityhttps://github.com/microsoft/TypeScript/security
Insightshttps://github.com/microsoft/TypeScript/insights
https://github.com/microsoft/TypeScript
New issuehttps://github.com/login?return_to=https://github.com/microsoft/TypeScript/issues/51005
New issuehttps://github.com/login?return_to=https://github.com/microsoft/TypeScript/issues/51005
intellisense for JSDocs on function overloads without needing to duplicate the JSDochttps://github.com/microsoft/TypeScript/issues/51005#top
DuplicateAn existing issue was already createdhttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Duplicate%22
https://github.com/mesqueeb
Luca Ban (mesqueeb)https://github.com/mesqueeb
on Sep 30, 2022https://github.com/microsoft/TypeScript/issues/51005#issue-1391789702
TypeScript's Design Goalshttps://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals
https://github.com/fatcerberus
Bruce Pascoe (fatcerberus)https://github.com/fatcerberus
on Sep 30, 2022https://github.com/microsoft/TypeScript/issues/51005#issuecomment-1263082187
#407https://github.com/microsoft/TypeScript/issues/407
Ryan Cavanaugh (RyanCavanaugh)https://github.com/RyanCavanaugh
DuplicateAn existing issue was already createdhttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Duplicate%22
on Sep 30, 2022https://github.com/microsoft/TypeScript/issues/51005#event-7498958829
TypeScript Bot (typescript-bot)https://github.com/typescript-bot
completedhttps://github.com/microsoft/TypeScript/issues?q=is%3Aissue%20state%3Aclosed%20archived%3Afalse%20reason%3Acompleted
on Oct 3, 2022https://github.com/microsoft/TypeScript/issues/51005#event-7509613832
https://github.com/typescript-bot
TypeScript Bot (typescript-bot)https://github.com/typescript-bot
on Oct 3, 2022https://github.com/microsoft/TypeScript/issues/51005#issuecomment-1265827152
https://github.com/mesqueeb
Luca Ban (mesqueeb)https://github.com/mesqueeb
on Oct 4, 2022https://github.com/microsoft/TypeScript/issues/51005#issuecomment-1266283050
TypeScript Bot (@typescript-bot)https://github.com/typescript-bot
microsofthttps://github.com/microsoft
on Oct 22, 2025https://github.com/microsoft/TypeScript/issues/51005#event-20417606815
Sign up for freehttps://github.com/signup?return_to=https://github.com/microsoft/TypeScript/issues/51005
Sign in to commenthttps://github.com/login?return_to=https://github.com/microsoft/TypeScript/issues/51005
DuplicateAn existing issue was already createdhttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Duplicate%22
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.