René's URL Explorer Experiment


Title: [Design Policy] Consider JSDoc feature parity with Typescript · Issue #30624 · microsoft/TypeScript · GitHub

Open Graph Title: [Design Policy] Consider JSDoc feature parity with Typescript · Issue #30624 · microsoft/TypeScript

X Title: [Design Policy] Consider JSDoc feature parity with Typescript · Issue #30624 · microsoft/TypeScript

Description: Search Terms jsdoc parity, jsdoc equivalence, jsdoc Suggestion The JSDoc mode of TypeScript is very useful in cases where a build step (esp for node libraries for example) isn't desired or when other constraints prevent not writing in JS...

Open Graph Description: Search Terms jsdoc parity, jsdoc equivalence, jsdoc Suggestion The JSDoc mode of TypeScript is very useful in cases where a build step (esp for node libraries for example) isn't desired or when oth...

X Description: Search Terms jsdoc parity, jsdoc equivalence, jsdoc Suggestion The JSDoc mode of TypeScript is very useful in cases where a build step (esp for node libraries for example) isn't desired or when...

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

X: @github

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"[Design Policy] Consider JSDoc feature parity with Typescript","articleBody":"## Search Terms\r\n\r\njsdoc parity, jsdoc equivalence, jsdoc\r\n\r\n## Suggestion\r\n\r\nThe JSDoc mode of TypeScript is very useful in cases where a build step (esp for node libraries for example) isn't desired or when other constraints prevent not writing in JS. However it can be annoying when trying to implement something that can't be expressed in JSDoc mode due to requiring Typescript syntax.\r\n\r\nAs such I would like to propose that TypeScript ensures that anything that can be written inside a `.ts` file can be expressed (in at least some way) within a pure javascript + jsdoc file.\r\n\r\nIn order to get an idea of the current scope needed for feature parity this is a list of issues and features that break parity between the two modes (if any are missing just say and I'll add to the list):\r\n\r\n- \u003cs>[Bug?] No way to express the `object` type\r\n  - Currently in JSDoc `/** @type {object} */` is equivalent to `/** @type {any} */`, there doesn't seem to be any way to represent `const x: object` purely in JS + JSDoc, this seems like a bug.\u003c/s> Fixed\r\n- `interface`\r\n- `abstract class`\r\n- \u003cs>`protected`/`private` members\u003c/s> Fixed\r\n- ~function overloading~ v5.0\r\n  - ~[open issue](https://github.com/Microsoft/TypeScript/issues/25590)~\r\n- ~defaults for generics~\r\n  - ~[open issue](https://github.com/Microsoft/TypeScript/issues/29401)~\r\n- `declare` syntax in it's various forms and declaration merging\r\n  - `declare global { ... }`\r\n  - `declare module \"moduleName\"`\r\n  - `declare class Foo`\r\n  - `declare interface`\r\n  - `declare namespace`\r\n- `namespace`\r\n- `enum`\r\n  - /** @enum */ is not quite equivalent\r\n- ~`as const`~ v4.5\r\n  - ~[open issue](https://github.com/Microsoft/TypeScript/issues/30445)~\r\n- non-null assertion `expr!`\r\n\r\n## Checklist\r\n\r\nMy suggestion meets these guidelines:\r\n\r\n* [✓] This wouldn't be a breaking change in existing TypeScript/JavaScript code\r\n* [✓] This wouldn't change the runtime behavior of existing JavaScript code\r\n* [✓] This could be implemented without emitting different JS based on the types of the expressions\r\n* [✓] This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)\r\n* [✓] 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","author":{"url":"https://github.com/Jamesernator","@type":"Person","name":"Jamesernator"},"datePublished":"2019-03-28T05:07:32Z","url":"https://github.com/microsoft/TypeScript/issues/30624"}

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:5328fb12-c718-6223-5453-4b5ac5bf837c
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-idD53C:B53AF:85B475:B3E9C1:6B00E156
html-safe-nonce6a5437788b5209e65d3cc1f1d2835895842e26c69fe7a144277a42ab2a40401c
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJENTNDOkI1M0FGOjg1QjQ3NTpCM0U5QzE6NkIwMEUxNTYiLCJ2aXNpdG9yX2lkIjoiMTg2MzQ1NzA1MDE5Mzg3OTM4MiIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9
visitor-hmac2ce4d0dfbb8d57a6234f900e00a4aed840749bf3a3d88fcd92b003b0785f4938
hovercard-subject-tagissue:426300927
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/30624/issue_layout
twitter:imagehttps://opengraph.githubassets.com/4876483bde2d9ba0584d0f26b71afb7e74869103fe7c6ca7ccf4256306f635a4/microsoft/TypeScript/issues/30624
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/4876483bde2d9ba0584d0f26b71afb7e74869103fe7c6ca7ccf4256306f635a4/microsoft/TypeScript/issues/30624
og:image:altSearch Terms jsdoc parity, jsdoc equivalence, jsdoc Suggestion The JSDoc mode of TypeScript is very useful in cases where a build step (esp for node libraries for example) isn't desired or when oth...
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernameJamesernator
hostnamegithub.com
expected-hostnamegithub.com
None043c3f30fbcbe2c6c8e729e10cbbbc90c406546f9fbbb67c648d38f6b7d16daf
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
release5425dc24e8bd8d6fca9641a12afc984825a43875
ui-targetfull
theme-color#1e2327
color-schemelight dark
react-app-nameissues

Links:

Skip to contenthttps://github.com/microsoft/TypeScript/issues/30624#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fmicrosoft%2FTypeScript%2Fissues%2F30624
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%2F30624
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/30624
Reloadhttps://github.com/microsoft/TypeScript/issues/30624
Reloadhttps://github.com/microsoft/TypeScript/issues/30624
microsofthttps://github.com/microsoft
TypeScripthttps://github.com/microsoft/TypeScript
Codehttps://github.com/microsoft/TypeScript
Issues5k (5k)https://github.com/microsoft/TypeScript/issues
Pull requests309 (309)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/30624
New issuehttps://github.com/login?return_to=https://github.com/microsoft/TypeScript/issues/30624
[Design Policy] Consider JSDoc feature parity with Typescripthttps://github.com/microsoft/TypeScript/issues/30624#top
Awaiting More FeedbackThis means we'd like to hear from more people who would be helped by this featurehttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Awaiting%20More%20Feedback%22
SuggestionAn idea for TypeScripthttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Suggestion%22
https://github.com/Jamesernator
James Browning (Jamesernator)https://github.com/Jamesernator
on Mar 28, 2019https://github.com/microsoft/TypeScript/issues/30624#issue-426300927
open issuehttps://github.com/Microsoft/TypeScript/issues/25590
open issuehttps://github.com/Microsoft/TypeScript/issues/29401
enumhttps://github.com/enum
open issuehttps://github.com/Microsoft/TypeScript/issues/30445
TypeScript's Design Goalshttps://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals
Daniel Rosenwasser (DanielRosenwasser)https://github.com/DanielRosenwasser
Meta-IssueAn issue about the team, or the direction of TypeScripthttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Meta-Issue%22
SuggestionAn idea for TypeScripthttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Suggestion%22
In DiscussionNot yet reached consensushttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22In%20Discussion%22
on Mar 28, 2019https://github.com/microsoft/TypeScript/issues/30624#event-2235221226
https://github.com/AlCalzone
AlCalzonehttps://github.com/AlCalzone
on Mar 28, 2019https://github.com/microsoft/TypeScript/issues/30624#issuecomment-477590359
https://github.com/AlCalzone/ioBroker.js-controller/blob/9fbbb890290b07af5d9dfb7ae90bf92f2d0be178/lib/tools.js#L1329https://github.com/AlCalzone/ioBroker.js-controller/blob/9fbbb890290b07af5d9dfb7ae90bf92f2d0be178/lib/tools.js#L1329
https://github.com/ExE-Boss
ExE Boss (ExE-Boss)https://github.com/ExE-Boss
on Apr 4, 2019https://github.com/microsoft/TypeScript/issues/30624#issuecomment-480021401
https://github.com/texastoland
Texas Toland (texastoland)https://github.com/texastoland
on Apr 18, 2019https://github.com/microsoft/TypeScript/issues/30624#issuecomment-484332318
#30445https://github.com/microsoft/TypeScript/issues/30445
https://github.com/steinuil
steen (steinuil)https://github.com/steinuil
on Apr 18, 2019https://github.com/microsoft/TypeScript/issues/30624#issuecomment-484424339
https://github.com/AlCalzone
AlCalzonehttps://github.com/AlCalzone
on Apr 18, 2019https://github.com/microsoft/TypeScript/issues/30624#issuecomment-484427740
https://github.com/steinuil
steen (steinuil)https://github.com/steinuil
on Apr 18, 2019https://github.com/microsoft/TypeScript/issues/30624#issuecomment-484432228
https://github.com/AlCalzone
AlCalzonehttps://github.com/AlCalzone
on Apr 18, 2019https://github.com/microsoft/TypeScript/issues/30624#issuecomment-484445726
steen (@steinuil)https://github.com/steinuil
https://github.com/texastoland
Texas Toland (texastoland)https://github.com/texastoland
on Apr 18, 2019https://github.com/microsoft/TypeScript/issues/30624#issuecomment-484542054
#23405https://github.com/microsoft/TypeScript/issues/23405
https://github.com/weswigham
Wesley Wigham (weswigham)https://github.com/weswigham
on Apr 18, 2019https://github.com/microsoft/TypeScript/issues/30624#issuecomment-484613811
AlCalzonehttps://github.com/AlCalzone
https://github.com/ExE-Boss
ExE Boss (ExE-Boss)https://github.com/ExE-Boss
on Apr 18, 2019https://github.com/microsoft/TypeScript/issues/30624#issuecomment-484620823
#27265https://github.com/microsoft/TypeScript/issues/27265
#30813https://github.com/microsoft/TypeScript/pull/30813
https://github.com/jonnytest1
Jonathan Heindl (jonnytest1)https://github.com/jonnytest1
on Jun 22, 2019https://github.com/microsoft/TypeScript/issues/30624#issuecomment-504665749
Anderson Goulart (@global)https://github.com/global
https://user-images.githubusercontent.com/13507796/59964495-d3a7b480-9501-11e9-8a1a-b78cc72621c7.png
Ryan Cavanaugh (RyanCavanaugh)https://github.com/RyanCavanaugh
In DiscussionNot yet reached consensushttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22In%20Discussion%22
SuggestionAn idea for TypeScripthttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Suggestion%22
on Jul 16, 2019https://github.com/microsoft/TypeScript/issues/30624#event-2487071273
https://github.com/thw0rted
James Bromwell (thw0rted)https://github.com/thw0rted
on Nov 27, 2019https://github.com/microsoft/TypeScript/issues/30624#issuecomment-559002624
#28730https://github.com/microsoft/TypeScript/issues/28730
https://github.com/bennypowers
Benny Powers (bennypowers)https://github.com/bennypowers
on Jan 27, 2020https://github.com/microsoft/TypeScript/issues/30624#issuecomment-578629310
https://github.com/trusktr
Joe Pea (trusktr)https://github.com/trusktr
on Feb 27, 2024https://github.com/microsoft/TypeScript/issues/30624#issuecomment-1965775916
Declaration merging in plain JS with JSDoc #57559https://github.com/microsoft/TypeScript/issues/57559
Ryan Cavanaugh (RyanCavanaugh)https://github.com/RyanCavanaugh
SuggestionAn idea for TypeScripthttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Suggestion%22
Awaiting More FeedbackThis means we'd like to hear from more people who would be helped by this featurehttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Awaiting%20More%20Feedback%22
Meta-IssueAn issue about the team, or the direction of TypeScripthttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Meta-Issue%22
on Oct 23, 2025https://github.com/microsoft/TypeScript/issues/30624#event-20465705786
Sign up for freehttps://github.com/signup?return_to=https://github.com/microsoft/TypeScript/issues/30624
Sign in to commenthttps://github.com/login?return_to=https://github.com/microsoft/TypeScript/issues/30624
Awaiting More FeedbackThis means we'd like to hear from more people who would be helped by this featurehttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Awaiting%20More%20Feedback%22
SuggestionAn idea for TypeScripthttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Suggestion%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.