René's URL Explorer Experiment


Title: Feature Request: Custom errors via type param utility when used as a default · Issue #41392 · microsoft/TypeScript · GitHub

Open Graph Title: Feature Request: Custom errors via type param utility when used as a default · Issue #41392 · microsoft/TypeScript

X Title: Feature Request: Custom errors via type param utility when used as a default · Issue #41392 · microsoft/TypeScript

Description: Search Terms Throw, error, in, type, param, custom, message, assert The Problem The ability to signal sources of error is critical to the productivity of both library developers and consumers; without this ability, it's easy to get lost ...

Open Graph Description: Search Terms Throw, error, in, type, param, custom, message, assert The Problem The ability to signal sources of error is critical to the productivity of both library developers and consumers; with...

X Description: Search Terms Throw, error, in, type, param, custom, message, assert The Problem The ability to signal sources of error is critical to the productivity of both library developers and consumers; with...

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

X: @github

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Feature Request: Custom errors via type param utility when used as a default","articleBody":"## Search Terms\r\n\r\nThrow, error, in, type, param, custom, message, assert\r\n\r\n## The Problem\r\n\r\nThe ability to signal sources of error is critical to the productivity of both library developers and consumers; without this ability, it's easy to get lost in a sea of difficult-to-trace `never`s.\r\n\r\nPR #40468 is incredibly exciting. However, it's unclear how users could specify the positioning and bubbling of error messages. This issue details a different approach, one using a would-be intrinsic `ParamError` utility type, which would be used in lieu of type variable defaults.\r\n\r\n## Suggestion\r\n\r\n```ts\r\ntype IsValid\u003cT> = // ... the predicate type\r\n\r\ntype WithComplexConstraint\u003c\r\n  InQuestion, // \u003c-- the type in need of validation\r\n  DidThrow = ParamError\u003c\"That's invalid!\", InQuestion, IsValid\u003cInQuestion> ? false : true>\r\n  //                    ^                  ^           ^\r\n  //                    |                  |           |\r\n  //                    |                  |           3. A boolean representing whether or not to error)\r\n  //                    |                  2. The type param over which to display the error\r\n  //                    1. The error message\r\n> = // ...\r\n```\r\n\r\nIn the use case below, I describe a generic `IsEmailAddress` predicate type, and an `acceptsEmailAddress` function, which constrains the first param according to the `IsEmailAddress` predicate. Here's how such validation would look using `ParamError`:\r\n\r\n```ts\r\ntype IsEmailAddress\u003cS extends string> = // ...\r\n\r\ndeclare function acceptsEmailAddress\u003c\r\n  S extends string,\r\n  IsInvalid = ParamError\u003c\"The supplied string type is not an email address type.\", S, IsEmailAddress\u003cS>>\r\n>(emailAddress: S): void;\r\n\r\nacceptsEmailAddress(\"rickross@smoothrapping.com\");\r\nacceptsEmailAddress(\"toppotdoughnuts.com\");\r\n//                   ~~~~~~~~~~~~~~~~~~~~\r\n//                   ^\r\n//                   type-error: \"The supplied string type is not an email address type.\"\r\n```\r\n\r\nOne could have multiple validations target the same type param:\r\n\r\n```ts\r\ntype IsEmailAddress\u003cS extends string> = // ...\r\ntype IsHotmailDotCom\u003cS extends string> = S extends `${infer Local}@hotmail.com` ? true : false;\r\n\r\ndeclare function acceptsEmailAddress\u003c\r\n  S extends string,\r\n  IsInvalid = ParamError\u003c\"The supplied string type is not an email address type.\", S, IsEmailAddress\u003cS>>,\r\n  IsHotmail = ParamError\u003c\"I respect it, but cummon... hotmail... in 2020? You still playing Neopets too?\", S, IsHotmailDotCom\u003cS>>\r\n>(emailAddress: S): void;\r\n\r\nacceptsEmailAddress(\"rickyrose@hotmail.com\");\r\n//                  ~~~~~~~~~~~~~~~~~~~~~~\r\n//                  ^\r\n//                  type-error: \"The supplied string type is not an email address type.\"\r\n//                  type-error: \"I respect it, but cummon... hotmail... in 2020? You still playing Neopets too?\"\r\n```\r\n\r\n## Use Case\r\n\r\nWhile the key use case is enabling library developers to create simpler error messaging experiences (and put aside the practice of `never`-hunting), you may have noticed another critical use case: **constraining params by more than just subtype**. Thanks to conditional and recursive types, we can traverse large structures and make judgements predicated upon more than could be represented with a subtype check.\r\n\r\nLet's say we want to validate that a string literal is an email address. We begin by building the `IsEmail` predicate and its children.\r\n\r\n```ts\r\ntype IsValidLocal\u003cS> extends string = // ...\r\ntype IsValidDomain\u003cS extends string> = // ...\r\ntype IsValidExtension\u003cS extends string> = // ...\r\n\r\ntype AllTrue\u003cT extends boolean[]> = // ...\r\n\r\ntype IsEmail\u003cS extends string> = S extends `${infer Local}@${infer Domain}.${infer Extension}`\r\n  ? AllTrue\u003c[IsValidLocal\u003cLocal>, IsValidDomain\u003cDomain>, IsValidExtension\u003cExtension>]>\r\n  : false;\r\n```\r\n\r\nThis is not a type that we can represent today as a generic constraint. Aka, we are unable to do the following:\r\n\r\n```ts\r\ntype EmailAddress = // ... somehow with the constraints defined above\r\n\r\ndeclare function acceptsEmailAddress(emailAddress: EmailAddress): void;\r\n```\r\n\r\nWhile I hope that [conditional assignability](https://github.com/microsoft/TypeScript/issues/40779) soon solves this problem, we're currently stuck. The only solutions seem to be:\r\n\r\n1. Leave the validation dangling beneath the function's usage (difficult to maintain / enforce).\r\n\r\n```ts\r\ndeclare function acceptsEmailAddress(emailAddress: string): void;\r\n\r\nconst emailAddress = \"rick@ross.com\";\r\nacceptsEmailAddress(emailAddress);\r\n\r\ntype EmailAddress = typeof emailAddress;\r\ntype UsedCorrectly = IsEmailAddress\u003cEmailAddress>;\r\nassert\u003cIsExact\u003cUsedCorrectly, true>>(true); // using `conditional-type-checks`\r\n```\r\n\r\n2. Produce an error-indicating return signature and check for that signature where `acceptsEmailAddress`'s output is referenced (also difficult to maintain / enforce).\r\n\r\n```ts\r\ntype Error\u003cMessage extends string> = {error: Message};\r\n\r\ndeclare function acceptsEmailAddress\u003cE extends string>(emailAddress: E): IsEmailAddress\u003cE> extends true ? Error\u003c\"Invalid email address supplied\"> : string;\r\n\r\nconst emailAddress = \"rick@ross.com\";\r\nconst result = acceptsEmailAddress(emailAddress);\r\n\r\ndeclare function acceptsResult(result: string): void;\r\n\r\nacceptsResult(result); // throws a type error if `emailAddress`'s type does not pass the `IsEmail` check\r\n```\r\n\r\n## 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, 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","author":{"url":"https://github.com/harrysolovay","@type":"Person","name":"harrysolovay"},"datePublished":"2020-11-04T00:03:42Z","url":"https://github.com/microsoft/TypeScript/issues/41392"}

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:1dfc15bc-c7ae-a2ff-8937-8f02eb5495ff
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-idDBFA:A71F9:1A3DFE7:2119C8A:6B0186BE
html-safe-noncef3a45397d29a2cb64ed3ab857afbc499c06cb28251016af5f8cd895b1c93fac5
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJEQkZBOkE3MUY5OjFBM0RGRTc6MjExOUM4QTo2QjAxODZCRSIsInZpc2l0b3JfaWQiOiI4MjU0MTQwOTgxMDA4NTAwNDE0IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0=
visitor-hmacf3c7596b8e6a4d64d5501a85c0414ccd548512b11e64fb05b72d97283d7be7d4
hovercard-subject-tagissue:735714891
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/41392/issue_layout
twitter:imagehttps://opengraph.githubassets.com/e9d3dea19b10eed9dab1a293235d7ed6ddb1617c7687d21e4f34bae64d153dc4/microsoft/TypeScript/issues/41392
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/e9d3dea19b10eed9dab1a293235d7ed6ddb1617c7687d21e4f34bae64d153dc4/microsoft/TypeScript/issues/41392
og:image:altSearch Terms Throw, error, in, type, param, custom, message, assert The Problem The ability to signal sources of error is critical to the productivity of both library developers and consumers; with...
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernameharrysolovay
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/41392#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fmicrosoft%2FTypeScript%2Fissues%2F41392
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%2F41392
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/41392
Reloadhttps://github.com/microsoft/TypeScript/issues/41392
Reloadhttps://github.com/microsoft/TypeScript/issues/41392
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/41392
New issuehttps://github.com/login?return_to=https://github.com/microsoft/TypeScript/issues/41392
Feature Request: Custom errors via type param utility when used as a defaulthttps://github.com/microsoft/TypeScript/issues/41392#top
DuplicateAn existing issue was already createdhttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Duplicate%22
https://github.com/harrysolovay
Harry Solovay (harrysolovay)https://github.com/harrysolovay
on Nov 4, 2020https://github.com/microsoft/TypeScript/issues/41392#issue-735714891
#40468https://github.com/microsoft/TypeScript/pull/40468
conditional assignabilityhttps://github.com/microsoft/TypeScript/issues/40779
TypeScript's Design Goalshttps://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals
https://github.com/MartinJohns
Martin Johns (MartinJohns)https://github.com/MartinJohns
on Nov 4, 2020https://github.com/microsoft/TypeScript/issues/41392#issuecomment-721445704
#23689https://github.com/microsoft/TypeScript/issues/23689
https://github.com/harrysolovay
Harry Solovay (harrysolovay)https://github.com/harrysolovay
on Nov 4, 2020https://github.com/microsoft/TypeScript/issues/41392#issuecomment-721483135
Martin Johns (@MartinJohns)https://github.com/MartinJohns
https://github.com/MartinJohns
Martin Johns (MartinJohns)https://github.com/MartinJohns
on Nov 4, 2020https://github.com/microsoft/TypeScript/issues/41392#issuecomment-721586021
https://github.com/harrysolovay
Harry Solovay (harrysolovay)https://github.com/harrysolovay
on Nov 4, 2020https://github.com/microsoft/TypeScript/issues/41392#issuecomment-721627428
Martin Johns (@MartinJohns)https://github.com/MartinJohns
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 12, 2020https://github.com/microsoft/TypeScript/issues/41392#event-3990826747
https://github.com/RyanCavanaugh
Ryan Cavanaugh (RyanCavanaugh)https://github.com/RyanCavanaugh
on Nov 12, 2020https://github.com/microsoft/TypeScript/issues/41392#issuecomment-726362600
#23689https://github.com/microsoft/TypeScript/issues/23689
https://github.com/harrysolovay
Harry Solovay (harrysolovay)https://github.com/harrysolovay
on Nov 12, 2020https://github.com/microsoft/TypeScript/issues/41392#issuecomment-726400928
Harry Solovay (harrysolovay)https://github.com/harrysolovay
completedhttps://github.com/microsoft/TypeScript/issues?q=is%3Aissue%20state%3Aclosed%20archived%3Afalse%20reason%3Acompleted
on Nov 12, 2020https://github.com/microsoft/TypeScript/issues/41392#event-3991086014
microsofthttps://github.com/microsoft
on Oct 21, 2025https://github.com/microsoft/TypeScript/issues/41392#event-20417058477
Sign up for freehttps://github.com/signup?return_to=https://github.com/microsoft/TypeScript/issues/41392
Sign in to commenthttps://github.com/login?return_to=https://github.com/microsoft/TypeScript/issues/41392
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.