René's URL Explorer Experiment


Title: Generating typescript definitions from JSDOC marked javascript fails · Issue #41250 · microsoft/TypeScript · GitHub

Open Graph Title: Generating typescript definitions from JSDOC marked javascript fails · Issue #41250 · microsoft/TypeScript

X Title: Generating typescript definitions from JSDOC marked javascript fails · Issue #41250 · microsoft/TypeScript

Description: TypeScript Version: tried both with 4.0.x and 4.1.0-dev.20201026 Search Terms: jsdoc generate javascript definitions Code The goal here is to create a index.d.ts for a library from a JSDoc documented javascript library, the problem is th...

Open Graph Description: TypeScript Version: tried both with 4.0.x and 4.1.0-dev.20201026 Search Terms: jsdoc generate javascript definitions Code The goal here is to create a index.d.ts for a library from a JSDoc document...

X Description: TypeScript Version: tried both with 4.0.x and 4.1.0-dev.20201026 Search Terms: jsdoc generate javascript definitions Code The goal here is to create a index.d.ts for a library from a JSDoc document...

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

X: @github

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Generating typescript definitions from JSDOC marked javascript fails","articleBody":"**TypeScript Version:**  tried both with 4.0.x and 4.1.0-dev.20201026\r\n\r\n**Search Terms:** jsdoc generate javascript definitions\r\n\r\n**Code**\r\n\r\nThe goal here is to create a index.d.ts for a library from a JSDoc documented javascript library, the problem is that if the type of an object specified in a file, in this case *rectangle.js*, is \"declared\" as parameter or return type in another one:\r\n\r\n```\r\n/**\r\n     * Adds a rectangle\r\n     * \r\n     * @returns {Rectangle} the rect\r\n     */\r\n  addRectangle() { /* ... */ }\r\n```\r\n\r\n... then an error is emitted since typescript tries to import it again as private symbol (at least this is my interpretation), a workaround pointed in another similar bug (closed) is to replace all the declarations of objects inside the JSDOC markup with something like:\r\n\r\n```\r\n/**\r\n     * Adds a rectangle\r\n     * \r\n     * @returns {import('./rectangle').Rectangle} the rect\r\n     */\r\n  addRectangle() { /* ... */ }\r\n```\r\n\r\n.... this works, but totally destroy the JSDoc markup of the library.\r\n\r\nSimple repo that reproduces the problem (we need 3 files to reproduce it so I thought to keep it external):\r\n\r\nhttps://github.com/ggreco/doc2dec\r\n\r\n - checkout the repo\r\n - npm install\r\n - npm run build (or npx tsc)\r\n\r\n**Expected behavior:**\r\n\r\nI expect the types to be generated correctly in \"types\" (index.d.ts and rectangle.d.ts).\r\n\r\n**Actual behavior:**\r\n\r\nThe compilation fails with this error:\r\n`error TS9006: Declaration emit for this file requires using private name 'Rectangle' from module '\"/Users/gabry/projects/ts-test/rectangle\"'. An explicit type annotation may unblock declaration emit.`\r\n\r\nindex.d.ts is not generated.\r\n\r\n**Related Issues:** \r\nhttps://github.com/microsoft/TypeScript/issues/37832 (closed but not for this particular case)\r\n\r\n\r\n","author":{"url":"https://github.com/ggreco","@type":"Person","name":"ggreco"},"datePublished":"2020-10-26T16:57:44Z","url":"https://github.com/microsoft/TypeScript/issues/41250"}

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:fa8e0f81-9421-6eed-393b-7aeedc30845e
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-idE796:2C4BED:2DE29A7:3A4CBC2:6B01BB93
html-safe-nonce60a6e8184b97d90451ed2319e0bdc82af1ce4a9d6156c944d0a402edef5c6b48
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJFNzk2OjJDNEJFRDoyREUyOUE3OjNBNENCQzI6NkIwMUJCOTMiLCJ2aXNpdG9yX2lkIjoiMzQ5ODE3ODEyNDgyMTE1MDYxMSIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9
visitor-hmac085d4beabef8215e9914ea2ecc7dea35d193a75f52b7a10a9509fee8ade8040f
hovercard-subject-tagissue:729739471
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/41250/issue_layout
twitter:imagehttps://opengraph.githubassets.com/ad109a07f74fda9a55c0105545f9efbdd5ed9b466c64744f96b6135e9cede3ea/microsoft/TypeScript/issues/41250
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/ad109a07f74fda9a55c0105545f9efbdd5ed9b466c64744f96b6135e9cede3ea/microsoft/TypeScript/issues/41250
og:image:altTypeScript Version: tried both with 4.0.x and 4.1.0-dev.20201026 Search Terms: jsdoc generate javascript definitions Code The goal here is to create a index.d.ts for a library from a JSDoc document...
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernameggreco
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/41250#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fmicrosoft%2FTypeScript%2Fissues%2F41250
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%2F41250
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/41250
Reloadhttps://github.com/microsoft/TypeScript/issues/41250
Reloadhttps://github.com/microsoft/TypeScript/issues/41250
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/41250
New issuehttps://github.com/login?return_to=https://github.com/microsoft/TypeScript/issues/41250
#41287https://github.com/microsoft/TypeScript/pull/41287
Generating typescript definitions from JSDOC marked javascript failshttps://github.com/microsoft/TypeScript/issues/41250#top
#41287https://github.com/microsoft/TypeScript/pull/41287
BugA bug in TypeScripthttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Bug%22
Domain: JSDocRelates to JSDoc parsing and type generationhttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Domain%3A%20JSDoc%22
https://github.com/ggreco
Gabriele Greco (ggreco)https://github.com/ggreco
on Oct 26, 2020https://github.com/microsoft/TypeScript/issues/41250#issue-729739471
https://github.com/ggreco/doc2dechttps://github.com/ggreco/doc2dec
#37832https://github.com/microsoft/TypeScript/issues/37832
https://github.com/Bnaya
Bnaya Peretz (Bnaya)https://github.com/Bnaya
on Oct 26, 2020https://github.com/microsoft/TypeScript/issues/41250#issuecomment-716689739
Wesley Wigham (weswigham)https://github.com/weswigham
BugA bug in TypeScripthttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Bug%22
Domain: JSDocRelates to JSDoc parsing and type generationhttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Domain%3A%20JSDoc%22
on Oct 26, 2020https://github.com/microsoft/TypeScript/issues/41250#event-3922959529
https://github.com/weswigham
Wesley Wigham (weswigham)https://github.com/weswigham
on Oct 26, 2020https://github.com/microsoft/TypeScript/issues/41250#issuecomment-716845478
Nathan Shively-Sanders (@sandersn)https://github.com/sandersn
fixhttps://github.com/microsoft/TypeScript/commit/ef810f5d0230e4dfbebd63b75a9420b623c15aad
Wesley Wigham (weswigham)https://github.com/weswigham
completedhttps://github.com/microsoft/TypeScript/issues?q=is%3Aissue%20state%3Aclosed%20archived%3Afalse%20reason%3Acompleted
#41287https://github.com/microsoft/TypeScript/pull/41287
on Oct 28, 2020https://github.com/microsoft/TypeScript/issues/41250#event-3933207632
microsofthttps://github.com/microsoft
on Oct 21, 2025https://github.com/microsoft/TypeScript/issues/41250#event-20417053823
Sign up for freehttps://github.com/signup?return_to=https://github.com/microsoft/TypeScript/issues/41250
Sign in to commenthttps://github.com/login?return_to=https://github.com/microsoft/TypeScript/issues/41250
BugA bug in TypeScripthttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Bug%22
Domain: JSDocRelates to JSDoc parsing and type generationhttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Domain%3A%20JSDoc%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.