René's URL Explorer Experiment


Title: Guidance on writing declaration file for multi-targeted libraries · Issue #4337 · microsoft/TypeScript · GitHub

Open Graph Title: Guidance on writing declaration file for multi-targeted libraries · Issue #4337 · microsoft/TypeScript

X Title: Guidance on writing declaration file for multi-targeted libraries · Issue #4337 · microsoft/TypeScript

Description: It is now possible for a library to hit every type of target that TypeScript supports (module, namespace, and ES6). Currently, writing a declaration file for a library like this can be very challenging. The default today is something lik...

Open Graph Description: It is now possible for a library to hit every type of target that TypeScript supports (module, namespace, and ES6). Currently, writing a declaration file for a library like this can be very challen...

X Description: It is now possible for a library to hit every type of target that TypeScript supports (module, namespace, and ES6). Currently, writing a declaration file for a library like this can be very challen...

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

X: @github

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Guidance on writing declaration file for multi-targeted libraries","articleBody":"It is now possible for a library to hit every type of target that TypeScript supports (module, namespace, and ES6). Currently, writing a declaration file for a library like this can be very challenging. The default today is something like this:\n\n``` typescript\ndeclare namespace MyLib {\n   export ...\n}\n\ndeclare module 'mylib' {\n  export = MyLib;\n}\n```\n\nThis has a couple issues:\n1. If you're using this in the module sense, using this declaration file will result in TypeScript thinking there is a globally available variable `MyLib` which is not actually true. This can lead to runtime errors. (see #2018)\n2. If you're using ES6 import syntax TypeScript will consider this module to be in the CommonJS style and will not allow default imports even though the library _actually_ supports them.\n\nIn the past, regarding item 1, it's been suggested that we split the declarations into two files (one for modules and one for namespaces). This makes sense. I think it also makes sense to extend that concept for ES6 modules. So if you have a library that targets all three, then you will have three mutually exclusive declaration files. Where things then become problematic is with duplicating the declarations in each file (which ideally should not happen). It is impossible to import an ambient module into an ambient namespace. It is possible to use an ambient namespace in an ambient module, but a naive approach to that (as shown in the common case above) violates item 1.\n\nTherefore, I propose this guidance to writing these declaration files.\n\n``` typescript\n// mylib-common.d.ts\n\ndeclare namespace __MyLib {\n  export ...\n}\n\n// mylib-namespace.d.ts\n\n/// \u003creference path=\"mylib-common.d.ts\" />\nimport MyLib = __MyLib;\n\n// mylib-module.d.ts\n\n/// \u003creference path=\"mylib-common.d.ts\" />\ndeclare module 'mylib' {\n  export = __MyLib;\n}\n\n// mylib-es6.d.ts\n\n/// \u003creference path=\"mylib-common.d.ts\" />\ndeclare module 'mylib' {\n  export * from __MyLib; // this doesn't currently work, see #4336\n  export default __MyLib; // if there is a default export\n}\n```\n\nUnfortunately this is currently hypothetical since you cannot re-export namespace declarations from an ES6 declaration.\n\nI'm proposing this as a baseline for discussion to solve this issue for good. It's possible I'm going down the wrong track or that there is already a better way to handle these cases. It would also be great if we could get some buy-in from the TypeScript language to solve this, if needed.\n\nSome possible ways TypeScript could be improved in this area:\n1. Fix #4336\n2. Make it so that `__MyLib` only exists as a namespace and not as a value, either through convention (prefixed with __) or through additional syntax.\n\ncc @johnnyreilly @vvakame \n","author":{"url":"https://github.com/jbrantly","@type":"Person","name":"jbrantly"},"datePublished":"2015-08-17T01:47:00Z","url":"https://github.com/microsoft/TypeScript/issues/4337"}

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:c84b97d4-a536-eaeb-317c-7651677d9ec7
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-id9922:229B2E:DC21FA:123B446:6B00FB6D
html-safe-noncee78d4a86942c811770df02ea04479b26e8047ca6aa95be502aa6703d67200b8e
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5OTIyOjIyOUIyRTpEQzIxRkE6MTIzQjQ0Njo2QjAwRkI2RCIsInZpc2l0b3JfaWQiOiIyNTgxODQyMDIwMzgxMjkzNDIxIiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0=
visitor-hmac5a2999e2ee9fdc3c90f88c5e3be52f3551fa264af7419ade5820884e83ccc04b
hovercard-subject-tagissue:101318135
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/4337/issue_layout
twitter:imagehttps://opengraph.githubassets.com/140d1a2207eb00b31f2310a9b30256b84bbb5b7e80091c951591e148950ee208/microsoft/TypeScript/issues/4337
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/140d1a2207eb00b31f2310a9b30256b84bbb5b7e80091c951591e148950ee208/microsoft/TypeScript/issues/4337
og:image:altIt is now possible for a library to hit every type of target that TypeScript supports (module, namespace, and ES6). Currently, writing a declaration file for a library like this can be very challen...
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernamejbrantly
hostnamegithub.com
expected-hostnamegithub.com
Nonee208d86428ec00a57ade75058166297440e8128a01e5287c31a53dc042bbf187
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
release7dafd017fb7809a839c443dba08622af38e63c09
ui-targetfull
theme-color#1e2327
color-schemelight dark
react-app-nameissues

Links:

Skip to contenthttps://github.com/microsoft/TypeScript/issues/4337#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fmicrosoft%2FTypeScript%2Fissues%2F4337
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%2F4337
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/4337
Reloadhttps://github.com/microsoft/TypeScript/issues/4337
Reloadhttps://github.com/microsoft/TypeScript/issues/4337
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/4337
New issuehttps://github.com/login?return_to=https://github.com/microsoft/TypeScript/issues/4337
Guidance on writing declaration file for multi-targeted librarieshttps://github.com/microsoft/TypeScript/issues/4337#top
https://github.com/RyanCavanaugh
@typesRelates to working with .d.ts files (declaration/definition files) from DefinitelyTypedhttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22%40types%22
CommittedThe team has roadmapped this issuehttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Committed%22
SuggestionAn idea for TypeScripthttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Suggestion%22
https://github.com/jbrantly
James Brantly (jbrantly)https://github.com/jbrantly
on Aug 17, 2015https://github.com/microsoft/TypeScript/issues/4337#issue-101318135
Create "Global / External-agnostic" declaration files without exposing internal definitions #2018https://github.com/microsoft/TypeScript/issues/2018
Re-exporting namespace declarations in ES6 ambient declaration #4336https://github.com/microsoft/TypeScript/issues/4336
John Reilly (@johnnyreilly)https://github.com/johnnyreilly
Masahiro Wakame (@vvakame)https://github.com/vvakame
https://github.com/johnnyreilly
John Reilly (johnnyreilly)https://github.com/johnnyreilly
on Aug 17, 2015https://github.com/microsoft/TypeScript/issues/4337#issuecomment-131676181
James Brantly (@jbrantly)https://github.com/jbrantly
Ryan Cavanaugh (RyanCavanaugh)https://github.com/RyanCavanaugh
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 Aug 18, 2015https://github.com/microsoft/TypeScript/issues/4337#event-385819092
https://github.com/mhegazy
Mohamed Hegazy (mhegazy)https://github.com/mhegazy
on Sep 5, 2015https://github.com/microsoft/TypeScript/issues/4337#issuecomment-137993365
John Reilly (@johnnyreilly)https://github.com/johnnyreilly
https://github.com/johnnyreilly
John Reilly (johnnyreilly)https://github.com/johnnyreilly
on Sep 5, 2015https://github.com/microsoft/TypeScript/issues/4337#issuecomment-137994118
Mohamed Hegazy (@mhegazy)https://github.com/mhegazy
https://github.com/jkillian
Jason Killian (jkillian)https://github.com/jkillian
on Oct 30, 2015https://github.com/microsoft/TypeScript/issues/4337#issuecomment-152557954
https://github.com/glen-84
Glen (glen-84)https://github.com/glen-84
on Nov 24, 2015https://github.com/microsoft/TypeScript/issues/4337#issuecomment-159278867
Mohamed Hegazy (mhegazy)https://github.com/mhegazy
@typesRelates to working with .d.ts files (declaration/definition files) from DefinitelyTypedhttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22%40types%22
on Feb 22, 2016https://github.com/microsoft/TypeScript/issues/4337#event-560349964
Mohamed Hegazy (mhegazy)https://github.com/mhegazy
Ryan Cavanaugh (RyanCavanaugh)https://github.com/RyanCavanaugh
on Feb 22, 2016https://github.com/microsoft/TypeScript/issues/4337#event-560350021
Ryan Cavanaugh (RyanCavanaugh)https://github.com/RyanCavanaugh
CommittedThe team has roadmapped this issuehttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Committed%22
In DiscussionNot yet reached consensushttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22In%20Discussion%22
on Apr 11, 2016https://github.com/microsoft/TypeScript/issues/4337#event-623133178
https://github.com/patsissons
Pat Sissons (patsissons)https://github.com/patsissons
on May 6, 2016https://github.com/microsoft/TypeScript/issues/4337#issuecomment-217542414
James Brantly (@jbrantly)https://github.com/jbrantly
https://github.com/mhegazy
Mohamed Hegazy (mhegazy)https://github.com/mhegazy
on Jul 21, 2016https://github.com/microsoft/TypeScript/issues/4337#issuecomment-234417257
https://github.com/Microsoft/TypeScript-Handbook/blob/master/pages/declaration%20files/Introduction.mdhttps://github.com/Microsoft/TypeScript-Handbook/blob/master/pages/declaration%20files/Introduction.md
Mohamed Hegazy (mhegazy)https://github.com/mhegazy
completedhttps://github.com/microsoft/TypeScript/issues?q=is%3Aissue%20state%3Aclosed%20archived%3Afalse%20reason%3Acompleted
on Jul 21, 2016https://github.com/microsoft/TypeScript/issues/4337#event-731142373
microsofthttps://github.com/microsoft
on Jun 19, 2018https://github.com/microsoft/TypeScript/issues/4337#event-1689610842
Sign up for freehttps://github.com/signup?return_to=https://github.com/microsoft/TypeScript/issues/4337
Sign in to commenthttps://github.com/login?return_to=https://github.com/microsoft/TypeScript/issues/4337
Ryan Cavanaugh (RyanCavanaugh)https://github.com/RyanCavanaugh
@typesRelates to working with .d.ts files (declaration/definition files) from DefinitelyTypedhttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22%40types%22
CommittedThe team has roadmapped this issuehttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Committed%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.