René's URL Explorer Experiment


Title: New Syntax: module implements Type · Issue #46942 · microsoft/TypeScript · GitHub

Open Graph Title: New Syntax: module implements Type · Issue #46942 · microsoft/TypeScript

X Title: New Syntax: module implements Type · Issue #46942 · microsoft/TypeScript

Description: Suggestion 🔍 Search Terms module interface type module implements module type ✅ Viability Checklist My suggestion meets these guidelines: This wouldn't be a breaking change in existing TypeScript/JavaScript code This wouldn't change the ...

Open Graph Description: Suggestion 🔍 Search Terms module interface type module implements module type ✅ Viability Checklist My suggestion meets these guidelines: This wouldn't be a breaking change in existing TypeScript/J...

X Description: Suggestion 🔍 Search Terms module interface type module implements module type ✅ Viability Checklist My suggestion meets these guidelines: This wouldn't be a breaking change in existing TypeScri...

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

X: @github

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"New Syntax: module implements Type","articleBody":"# Suggestion\r\n\r\n\u003c!--\r\n  Please fill in each section completely. Thank you!\r\n-->\r\n\r\n## 🔍 Search Terms\r\n\r\n- module interface type\r\n- module implements\r\n- module type\r\n\r\n## ✅ Viability Checklist\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\r\n## ⭐ Suggestion\r\n\r\nI want to add a new syntax for setting export types for a module:\r\n\r\n```ts\r\nimport type {MyType} from './types'\r\n\r\nmodule implements MyType\r\n```\r\n\r\nShorthand syntax:\r\n\r\n```ts\r\nmodule implements {MyType} from './types'\r\n```\r\n\r\nDefault type export shorthand syntax:\r\n\r\n```ts\r\nmodule implements {default} from './types'\r\n```\r\n\r\nNote: I'm much more interested in the feature than the syntax.\r\n\r\n## 📃 Motivating Example\r\n\r\nI want to be able to do this:\r\n\r\n```ts\r\n// types.ts\r\nexport type Math = {\r\n  add: (a: number, b: number) => number\r\n  subtract: (a: number, b: number) => number\r\n  multiply?: (a: number, b: number) => number\r\n  pi: number\r\n}\r\n\r\n// my-math-module.ts\r\nimport type {Math} from './types'\r\n\r\nmodule implements Math // \u003c-- this is the feature I want\r\n\r\nexport function add(a, b) { // \u003c-- the types are set by and checked against the module implements syntax\r\n  return a + b\r\n}\r\n\r\nexport function subtract(a, b) { // \u003c-- the types are set by and checked against the module implements syntax\r\n  return a - b\r\n}\r\n\r\n// extra exports are fine, they just don't inherit the type\r\nexport function divide(a: number, b: number): number {\r\n  return a / b\r\n}\r\n\r\n// optional types do not have to be exported, so no multiply here\r\n\r\n// not just functions!\r\nexport const pi = 3.14\r\n```\r\n\r\nSee, you can have a conventional module format and get automatic typings for everything the module is supposed to export.\r\n\r\n## 💻 Use Cases\r\n\r\nSome libraries have conventions for modules. I thinking specifically of [Remix](https://remix.run/docs/en/v1/api/conventions#route-module-api), but other frameworks have similar conventions (like [Next.js](https://nextjs.org/docs/basic-features/pages), [SvelteKit](https://kit.svelte.dev/docs), and [Storybook](https://storybook.js.org/docs/react/get-started/whats-a-story)). For example, in Remix a route module should export the following interface:\r\n\r\n```ts\r\ninterface EntryRouteModule {\r\n  CatchBoundary?: CatchBoundaryComponent;\r\n  ErrorBoundary?: ErrorBoundaryComponent;\r\n  default?: RouteComponent;\r\n  handle?: RouteHandle;\r\n  links?: LinksFunction;\r\n  meta?: MetaFunction | HtmlMetaDescriptor;\r\n  action?: ActionFunction;\r\n  headers?: HeadersFunction | { [name: string]: string };\r\n  loader?: LoaderFunction;\r\n}\r\n```\r\n\r\nThe issue here is that as a user of the convention, I have to type everything I export. This comes with two problems:\r\n\r\n1. If I forget, I don't have anything running at compile time to tell me I forgot.\r\n2. It's extra typing (both figuratively and literally)\r\n3. If what I'm exporting is a function, I can't easily use a function declaration which I prefer.\r\n\r\nSo, for example, I currently have to do this:\r\n\r\n```ts\r\nimport {type LoaderFunction} from 'remix'\r\n\r\nexport const loader: LoaderFunction = async ({request}) => {\r\n  return {url: request.url}\r\n}\r\n```\r\n\r\nWhat I want to be able to do is this:\r\n\r\n```ts\r\nmodule implements {RouteModule} from 'remix'\r\n\r\nexport async function loader({request}) {\r\n  return {url: request.url}\r\n}\r\n```\r\n\r\nPlease let me know if you need any other details. Thanks for taking the time to read and consider!","author":{"url":"https://github.com/kentcdodds","@type":"Person","name":"kentcdodds"},"datePublished":"2021-11-29T05:07:55Z","url":"https://github.com/microsoft/TypeScript/issues/46942"}

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:66ba93b6-2a5c-b112-338e-8c62dd5bd4ff
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-idC00A:2C4BED:237E643:2D142E6:6B01821D
html-safe-nonce80667309242905545264939abdd3fe5ed42434da9882d054b9de1afdb8588199
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJDMDBBOjJDNEJFRDoyMzdFNjQzOjJEMTQyRTY6NkIwMTgyMUQiLCJ2aXNpdG9yX2lkIjoiNDM0NzUzOTkyMjI5MTM2MDI4NSIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9
visitor-hmac8b63111758c08a48d7c2ff5b21358ca66e27f2f8decbd29090fbf245710b99bb
hovercard-subject-tagissue:1065616032
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/46942/issue_layout
twitter:imagehttps://opengraph.githubassets.com/022d090aa6fe27c3d9edc318f13c118042b93655d126408c2ffc180f7e9c7aa0/microsoft/TypeScript/issues/46942
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/022d090aa6fe27c3d9edc318f13c118042b93655d126408c2ffc180f7e9c7aa0/microsoft/TypeScript/issues/46942
og:image:altSuggestion 🔍 Search Terms module interface type module implements module type ✅ Viability Checklist My suggestion meets these guidelines: This wouldn't be a breaking change in existing TypeScript/J...
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernamekentcdodds
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/46942#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fmicrosoft%2FTypeScript%2Fissues%2F46942
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%2F46942
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/46942
Reloadhttps://github.com/microsoft/TypeScript/issues/46942
Reloadhttps://github.com/microsoft/TypeScript/issues/46942
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/46942
New issuehttps://github.com/login?return_to=https://github.com/microsoft/TypeScript/issues/46942
New Syntax: module implements Typehttps://github.com/microsoft/TypeScript/issues/46942#top
DuplicateAn existing issue was already createdhttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Duplicate%22
https://github.com/kentcdodds
Kent C. Dodds (kentcdodds)https://github.com/kentcdodds
on Nov 29, 2021https://github.com/microsoft/TypeScript/issues/46942#issue-1065616032
TypeScript's Design Goalshttps://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals
Remixhttps://remix.run/docs/en/v1/api/conventions#route-module-api
Next.jshttps://nextjs.org/docs/basic-features/pages
SvelteKithttps://kit.svelte.dev/docs
Storybookhttps://storybook.js.org/docs/react/get-started/whats-a-story
Kent C. Dodds (kentcdodds)https://github.com/kentcdodds
on Nov 29, 2021https://github.com/microsoft/TypeScript/issues/46942#event-5682540650
https://github.com/spencersmb
spencer (spencersmb)https://github.com/spencersmb
on Nov 29, 2021https://github.com/microsoft/TypeScript/issues/46942#issuecomment-981306677
https://github.com/eyelidlessness
Trevor Schmidt (eyelidlessness)https://github.com/eyelidlessness
on Nov 29, 2021https://github.com/microsoft/TypeScript/issues/46942#issuecomment-981309626
https://github.com/MartinJohns
Martin Johns (MartinJohns)https://github.com/MartinJohns
on Nov 29, 2021https://github.com/microsoft/TypeScript/issues/46942#issuecomment-981311344
#38511https://github.com/microsoft/TypeScript/issues/38511
https://github.com/Saeris
Drake Costa (Saeris)https://github.com/Saeris
on Nov 29, 2021https://github.com/microsoft/TypeScript/issues/46942#issuecomment-981349377
Kent C. Dodds (@kentcdodds)https://github.com/kentcdodds
https://github.com/kettanaito
Artem Zakharchenko (kettanaito)https://github.com/kettanaito
on Nov 29, 2021https://github.com/microsoft/TypeScript/issues/46942#issuecomment-981399661
https://github.com/dechowdev
Lucas Dechow (dechowdev)https://github.com/dechowdev
on Nov 29, 2021https://github.com/microsoft/TypeScript/issues/46942#issuecomment-981456885
https://github.com/ubmit
gui de andrade (ubmit)https://github.com/ubmit
on Nov 29, 2021https://github.com/microsoft/TypeScript/issues/46942#issuecomment-981494957
#38511https://github.com/microsoft/TypeScript/issues/38511
https://github.com/intrnl
intrnlhttps://github.com/intrnl
on Nov 29, 2021https://github.com/microsoft/TypeScript/issues/46942#issuecomment-981497932
https://github.com/MartinJohns
Martin Johns (MartinJohns)https://github.com/MartinJohns
on Nov 29, 2021https://github.com/microsoft/TypeScript/issues/46942#issuecomment-981509792
GuilhermedeAndradehttps://github.com/GuilhermedeAndrade
intrnlhttps://github.com/intrnl
Quoting RyanCavanaughhttps://github.com/microsoft/TypeScript/issues/41392#issuecomment-726362600
https://github.com/cevr
Cristian Velasquez Ramos (cevr)https://github.com/cevr
on Nov 29, 2021https://github.com/microsoft/TypeScript/issues/46942#issuecomment-981752007
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 Nov 29, 2021https://github.com/microsoft/TypeScript/issues/46942#event-5686067329
https://github.com/RyanCavanaugh
Ryan Cavanaugh (RyanCavanaugh)https://github.com/RyanCavanaugh
on Nov 29, 2021https://github.com/microsoft/TypeScript/issues/46942#issuecomment-981786072
Ryan Cavanaugh (RyanCavanaugh)https://github.com/RyanCavanaugh
completedhttps://github.com/microsoft/TypeScript/issues?q=is%3Aissue%20state%3Aclosed%20archived%3Afalse%20reason%3Acompleted
on Nov 29, 2021https://github.com/microsoft/TypeScript/issues/46942#event-5686071563
microsofthttps://github.com/microsoft
on Nov 29, 2021https://github.com/microsoft/TypeScript/issues/46942#event-5686072321
Sign up for freehttps://github.com/signup?return_to=https://github.com/microsoft/TypeScript/issues/46942
Sign in to commenthttps://github.com/login?return_to=https://github.com/microsoft/TypeScript/issues/46942
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.