René's URL Explorer Experiment


Title: Module augmentation difficulties with AMD/CommonJS/globals · Issue #7015 · microsoft/TypeScript · GitHub

Open Graph Title: Module augmentation difficulties with AMD/CommonJS/globals · Issue #7015 · microsoft/TypeScript

X Title: Module augmentation difficulties with AMD/CommonJS/globals · Issue #7015 · microsoft/TypeScript

Description: I'm just curious about the rationale for the following aspect of the new module augmentation feature in v1.8: Neither module augmentations nor global augmentations can add new items to the top level scope - they can only "patch" existing...

Open Graph Description: I'm just curious about the rationale for the following aspect of the new module augmentation feature in v1.8: Neither module augmentations nor global augmentations can add new items to the top leve...

X Description: I'm just curious about the rationale for the following aspect of the new module augmentation feature in v1.8: Neither module augmentations nor global augmentations can add new items to the top ...

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

X: @github

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Module augmentation difficulties with AMD/CommonJS/globals","articleBody":"I'm just curious about the rationale for the following aspect of the new [module augmentation feature in v1.8](https://github.com/Microsoft/TypeScript/wiki/What%27s-new-in-TypeScript#augmenting-globalmodule-scope-from-modules):\n\n> Neither module augmentations nor global augmentations can add new items to the top level scope - they can only \"patch\" existing declarations.\n\nI couldn't find any discussion about _why_ this restriction exists. Is it technical? It is to direct people towards specific practices?\n\nI ask because it seems to make it difficult to model existing JavaScript behaviour in some cases.\n### Example: A jQuery Plugin\n\nWith this restriction in place, what is the best way, for example, to write the type declaration for `plugin`, which adds itself as a top-level property of the object exported by `jquery`? Assume AMD module loading. I tried a few approaches:\n#### Option 1\n\nThis is to me the most obvious and the simplest approach, but it is not allowed.\n\n``` typescript\n// file: plugin.d.ts\ndeclare module 'jquery' {\n    export var plugin: Plugin; // ERROR: cannot introduce new names in top level scope\n}\n\nexport interface Plugin {/***/}\n// Other exports...\n```\n#### Option 2\n\nThis approach tries to augment an existing declaration to satisfy the augmentation rules.\n\n``` typescript\n// file: plugin.d.ts\ndeclare module 'jquery' {\n    interface JQueryStatic { // ERROR: cannot introduce new names in top level scope\n        plugin: Plugin;\n    }\n}\n\nexport interface Plugin {/***/}\n// Other exports...\n```\n\nOption 2 still doesn't work because `JQueryStatic` is not exported from `jquery`. There are also other problems with this approach:\n- even if `JQueryStatic` was exported (which makes this option work), the augmenter needs to study the 'internal' details of `jquery.d.ts` to find the right name to augment. This seems like an unnecessary detail, not to mention risky because the name might be changed in a future `jquery.d.ts` rearrangement.\n- Just adding `export` in front of `JQueryStatic` in `jquery.d.ts` doesn't work, because, like _very many_ typings on DefinitelyTyped, it uses `export=` syntax which precludes other exports, so to export `JQueryStatic` would involve more extensive changes in `jquery.d.ts`.\n#### Option 3\n\nThis approach works, but doesn't use the new module augmentation feature at all. It relies on good old ambient declarations.\n\n``` typescript\n// file: plugin.d.ts\ninterface JQueryStatic {\n    plugin: Plugin;\n}\n// IMPORTANT: must be no imports or exports in this file!\ninterface Plugin {/***/}\n```\n\nOption 3 also has problems:\n- It falls back to namespace-polluting ambient declarations. This is undesirable for several reasons. I thought this was one of the issues that module augmentations aimed to address.\n- Now `plugin.d.ts` must remain purely ambient for this to work. If `plugin` declares its own exports (e.g. exporting the `Plugin` interface), then `plugin.d.ts` will be treated as its own module, and the augmentation of `JQueryStatic` fails because it's no longer the _global_ `JQueryStatic`, but an unrelated local one. (And this error is cryptic enough to cause confusion - e.g. see #4166, #5944).\n\n---\n\nI've used `jquery` as an example, but this also applies to global augmentations, and of course to other commonly augmented JavaScript libraries.\n","author":{"url":"https://github.com/yortus","@type":"Person","name":"yortus"},"datePublished":"2016-02-11T06:38:02Z","url":"https://github.com/microsoft/TypeScript/issues/7015"}

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:989315eb-60e4-4d67-6bcf-2d18d93a3fac
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-id9EC0:D0E46:C2FC0F:102AA04:6B00F3A1
html-safe-noncefe13a0f3682a71866ef62d6d93cecbdee9cb3b6b6ba61b7bd234c65d8d46be3a
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5RUMwOkQwRTQ2OkMyRkMwRjoxMDJBQTA0OjZCMDBGM0ExIiwidmlzaXRvcl9pZCI6IjUzODA2MTM5Mzc5MTYwODEwNTgiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ==
visitor-hmac069c59863b072e7a6f6b5084a427af4e6aa6f188eee67c8a532528b5e79949c0
hovercard-subject-tagissue:132901481
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/7015/issue_layout
twitter:imagehttps://opengraph.githubassets.com/ad175257aaa7e5453c1860415710a00e5fcf01f26bfbb7a1d75856a9431609f1/microsoft/TypeScript/issues/7015
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/ad175257aaa7e5453c1860415710a00e5fcf01f26bfbb7a1d75856a9431609f1/microsoft/TypeScript/issues/7015
og:image:altI'm just curious about the rationale for the following aspect of the new module augmentation feature in v1.8: Neither module augmentations nor global augmentations can add new items to the top leve...
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernameyortus
hostnamegithub.com
expected-hostnamegithub.com
None4ef498cbabcbe3c50befc7a5b743e7072ee770b4daf0e15e54801180d1fa91fc
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
release9983dd5da06943f833c971dd5b6bc988e2858be5
ui-targetfull
theme-color#1e2327
color-schemelight dark
react-app-nameissues

Links:

Skip to contenthttps://github.com/microsoft/TypeScript/issues/7015#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fmicrosoft%2FTypeScript%2Fissues%2F7015
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%2F7015
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/7015
Reloadhttps://github.com/microsoft/TypeScript/issues/7015
Reloadhttps://github.com/microsoft/TypeScript/issues/7015
microsofthttps://github.com/microsoft
TypeScripthttps://github.com/microsoft/TypeScript
Codehttps://github.com/microsoft/TypeScript
Issues5k (5k)https://github.com/microsoft/TypeScript/issues
Pull requests308 (308)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/7015
New issuehttps://github.com/login?return_to=https://github.com/microsoft/TypeScript/issues/7015
Module augmentation difficulties with AMD/CommonJS/globalshttps://github.com/microsoft/TypeScript/issues/7015#top
QuestionAn issue which isn't directly actionable in codehttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Question%22
https://github.com/yortus
Troy Gerwien (yortus)https://github.com/yortus
on Feb 11, 2016https://github.com/microsoft/TypeScript/issues/7015#issue-132901481
module augmentation feature in v1.8https://github.com/Microsoft/TypeScript/wiki/What%27s-new-in-TypeScript#augmenting-globalmodule-scope-from-modules
Provide a way to augment global interfaces from external modules #4166https://github.com/microsoft/TypeScript/issues/4166
Extending the Function interface in the presence of an import statement #5944https://github.com/microsoft/TypeScript/issues/5944
https://github.com/weswigham
Wesley Wigham (weswigham)https://github.com/weswigham
on Feb 11, 2016https://github.com/microsoft/TypeScript/issues/7015#issuecomment-182738156
https://github.com/yortus
Troy Gerwien (yortus)https://github.com/yortus
on Feb 11, 2016https://github.com/microsoft/TypeScript/issues/7015#issuecomment-182738940
Wesley Wigham (@weswigham)https://github.com/weswigham
Troy Gerwien (yortus)https://github.com/yortus
on Feb 12, 2016https://github.com/microsoft/TypeScript/issues/7015#event-547936030
https://github.com/Seikho
Carl (Seikho)https://github.com/Seikho
on Feb 15, 2016https://github.com/microsoft/TypeScript/issues/7015#issuecomment-184034426
https://github.com/mhegazy
Mohamed Hegazy (mhegazy)https://github.com/mhegazy
on Feb 17, 2016https://github.com/microsoft/TypeScript/issues/7015#issuecomment-184943914
Mohamed Hegazy (mhegazy)https://github.com/mhegazy
QuestionAn issue which isn't directly actionable in codehttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Question%22
on Feb 17, 2016https://github.com/microsoft/TypeScript/issues/7015#event-552871724
https://github.com/yortus
Troy Gerwien (yortus)https://github.com/yortus
on Feb 17, 2016https://github.com/microsoft/TypeScript/issues/7015#issuecomment-184955172
Mohamed Hegazy (@mhegazy)https://github.com/mhegazy
https://github.com/mhegazy
Mohamed Hegazy (mhegazy)https://github.com/mhegazy
on Feb 17, 2016https://github.com/microsoft/TypeScript/issues/7015#issuecomment-184968080
https://github.com/yortus
Troy Gerwien (yortus)https://github.com/yortus
on Feb 17, 2016https://github.com/microsoft/TypeScript/issues/7015#issuecomment-184973643
https://github.com/yortus
Troy Gerwien (yortus)https://github.com/yortus
on Feb 17, 2016https://github.com/microsoft/TypeScript/issues/7015#issuecomment-185006083
Mohamed Hegazy (@mhegazy)https://github.com/mhegazy
Wesley Wigham (@weswigham)https://github.com/weswigham
#6742https://github.com/microsoft/TypeScript/pull/6742
#6742https://github.com/microsoft/TypeScript/pull/6742
https://github.com/mhegazy
Mohamed Hegazy (mhegazy)https://github.com/mhegazy
on Feb 20, 2016https://github.com/microsoft/TypeScript/issues/7015#issuecomment-186473184
#7125https://github.com/microsoft/TypeScript/issues/7125
Mohamed Hegazy (mhegazy)https://github.com/mhegazy
completedhttps://github.com/microsoft/TypeScript/issues?q=is%3Aissue%20state%3Aclosed%20archived%3Afalse%20reason%3Acompleted
on Feb 20, 2016https://github.com/microsoft/TypeScript/issues/7015#event-557315753
https://github.com/yortus
Troy Gerwien (yortus)https://github.com/yortus
on Feb 20, 2016https://github.com/microsoft/TypeScript/issues/7015#issuecomment-186488539
Mohamed Hegazy (@mhegazy)https://github.com/mhegazy
#7125https://github.com/microsoft/TypeScript/issues/7125
#7125https://github.com/microsoft/TypeScript/issues/7125
https://github.com/yortus
Troy Gerwien (yortus)https://github.com/yortus
on Feb 20, 2016https://github.com/microsoft/TypeScript/issues/7015#issuecomment-186489305
#7148https://github.com/microsoft/TypeScript/issues/7148
https://github.com/yortus
Troy Gerwien (yortus)https://github.com/yortus
on Feb 20, 2016https://github.com/microsoft/TypeScript/issues/7015#issuecomment-186490482
#7015 (comment)https://github.com/microsoft/TypeScript/issues/7015#issuecomment-184943914
#7161https://github.com/microsoft/TypeScript/issues/7161
https://github.com/mhegazy
Mohamed Hegazy (mhegazy)https://github.com/mhegazy
on Feb 22, 2016https://github.com/microsoft/TypeScript/issues/7015#issuecomment-187437445
Troy Gerwien (@yortus)https://github.com/yortus
#7148https://github.com/microsoft/TypeScript/issues/7148
microsofthttps://github.com/microsoft
on Jun 19, 2018https://github.com/microsoft/TypeScript/issues/7015#event-1689638282
Sign up for freehttps://github.com/signup?return_to=https://github.com/microsoft/TypeScript/issues/7015
Sign in to commenthttps://github.com/login?return_to=https://github.com/microsoft/TypeScript/issues/7015
QuestionAn issue which isn't directly actionable in codehttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Question%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.