René's URL Explorer Experiment


Title: satisfies support in JSDoc · Issue #51086 · microsoft/TypeScript · GitHub

Open Graph Title: satisfies support in JSDoc · Issue #51086 · microsoft/TypeScript

X Title: satisfies support in JSDoc · Issue #51086 · microsoft/TypeScript

Description: Suggestion 🔍 Search Terms satisfies, jsdoc ✅ Viability Checklist My suggestion meets these guidelines: This wouldn't be a breaking change in existing TypeScript/JavaScript code This wouldn't change the runtime behavior of existing JavaSc...

Open Graph Description: Suggestion 🔍 Search Terms satisfies, jsdoc ✅ Viability Checklist My suggestion meets these guidelines: This wouldn't be a breaking change in existing TypeScript/JavaScript code This wouldn't change...

X Description: Suggestion 🔍 Search Terms satisfies, jsdoc ✅ Viability Checklist My suggestion meets these guidelines: This wouldn't be a breaking change in existing TypeScript/JavaScript code This wouldn'...

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

X: @github

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"satisfies support in JSDoc","articleBody":"# Suggestion\r\n\u003c!--\r\n  Please fill in each section completely. Thank you!\r\n-->\r\n\r\n## 🔍 Search Terms\r\nsatisfies, jsdoc\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## ⭐ Suggestion\r\n\r\nIt would be fantastic to have `satisfies` support in jsdoc. This was previously discussed in the [satisfies PR](https://github.com/microsoft/TypeScript/pull/46827#issuecomment-1256844006) (with the suggestion to open a separate tracking issue) and in the [8/17/2022 Design Meeting](https://github.com/microsoft/TypeScript/issues/50522).\r\n\r\nThere was a discussion about using `/** @type {satisfies T} */`, but I would love to see TS be more opinionated on this and go for `/** @satisfies {T} */`.\r\n\r\nTwo main reasons:\r\n- more straightforward in intent and keeps already-lengthy jsdoc lines from getting even longer\r\n- allows the same functionality as ts files if (for some reason) you really want to include a type annotation and a `satisfies` clause. There aren't great reasons to do this, but the fewer functionality differences between ts and jsdoc the better.\r\n\r\nThe design meeting mentioned:\r\n\r\n> We try not to add new tags that aren't doc'd in the usejsdoc site.\r\n> Ship has sailed with TS-specific syntax in JSDoc, right?\r\n\r\nBut: unknown tags are common in the wild and `jsdoc` ([the utility](https://www.npmjs.com/package/jsdoc)) has `allowUnknownTags` set by default, so `@satisfies` information isn't included in the generated docs, but it also doesn't cause any errors. Parser-wise, it should also be relatively easy to support in the future, if there's a desire.\r\n\r\nThe syntax ship has definitely sailed, in contrast. TS hasn't added tags before AFAIK, but common TS-specific syntax is already often not parsed and causes errors (e.g. [`/** @type {{name: string}[]} */ const arr = [];`](https://github.com/jsdoc/jsdoc/issues/1628#issuecomment-584448870)).\r\n\r\n## 📃 Motivating Example\r\n\r\n```js\r\n/** @typedef {\"red\" | \"green\" | \"blue\"} Colors */\r\n\r\n/**\r\n * Ensure that we have exactly the keys from 'Colors'.\r\n * @satisfies {Record\u003cColors, unknown>}\r\n */\r\nconst favoriteColors = {\r\n    red: 'yes',\r\n    green: false,\r\n    blue: 'kinda',\r\n    platypus: false,\r\n//  ~~~~~~~~ error - \"platypus\" was never listed in 'Colors'.\r\n}\r\n```\r\n\r\n## 💻 Use Cases\r\n\r\n`satisfies` in jsdoc!\r\n","author":{"url":"https://github.com/brendankenny","@type":"Person","name":"brendankenny"},"datePublished":"2022-10-06T18:37:36Z","url":"https://github.com/microsoft/TypeScript/issues/51086"}

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:53838488-55ca-d0af-f96e-d69dcf1e1fdc
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-idE4D4:B53AF:2388A8F:2F4E98D:6B019438
html-safe-noncef64552a998278bb97fd1b63122b63155926d23985aaf6270dd68363ce73dd6e9
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJFNEQ0OkI1M0FGOjIzODhBOEY6MkY0RTk4RDo2QjAxOTQzOCIsInZpc2l0b3JfaWQiOiI3NTk0MTY4MDU1NjcyOTY4MjQ4IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0=
visitor-hmac5daf09f049115b872906fe01a90f74eed0c9e32edbb9e8889439280cb7e6d4f9
hovercard-subject-tagissue:1400136841
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/51086/issue_layout
twitter:imagehttps://opengraph.githubassets.com/4a097a64c5709d394800393f272df01d632edf349ecdfbf0a3e4b8d815bd1d4c/microsoft/TypeScript/issues/51086
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/4a097a64c5709d394800393f272df01d632edf349ecdfbf0a3e4b8d815bd1d4c/microsoft/TypeScript/issues/51086
og:image:altSuggestion 🔍 Search Terms satisfies, jsdoc ✅ Viability Checklist My suggestion meets these guidelines: This wouldn't be a breaking change in existing TypeScript/JavaScript code This wouldn't change...
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernamebrendankenny
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/51086#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fmicrosoft%2FTypeScript%2Fissues%2F51086
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%2F51086
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/51086
Reloadhttps://github.com/microsoft/TypeScript/issues/51086
Reloadhttps://github.com/microsoft/TypeScript/issues/51086
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/51086
New issuehttps://github.com/login?return_to=https://github.com/microsoft/TypeScript/issues/51086
#51753https://github.com/microsoft/TypeScript/pull/51753
satisfies support in JSDochttps://github.com/microsoft/TypeScript/issues/51086#top
#51753https://github.com/microsoft/TypeScript/pull/51753
Domain: JSDocRelates to JSDoc parsing and type generationhttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Domain%3A%20JSDoc%22
In DiscussionNot yet reached consensushttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22In%20Discussion%22
SuggestionAn idea for TypeScripthttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Suggestion%22
https://github.com/brendankenny
Brendan Kenny (brendankenny)https://github.com/brendankenny
on Oct 6, 2022https://github.com/microsoft/TypeScript/issues/51086#issue-1400136841
TypeScript's Design Goalshttps://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals
satisfies PRhttps://github.com/microsoft/TypeScript/pull/46827#issuecomment-1256844006
8/17/2022 Design Meetinghttps://github.com/microsoft/TypeScript/issues/50522
the utilityhttps://www.npmjs.com/package/jsdoc
/** @type {{name: string}[]} */ const arr = [];https://github.com/jsdoc/jsdoc/issues/1628#issuecomment-584448870
https://github.com/DanielRosenwasser
Daniel Rosenwasser (DanielRosenwasser)https://github.com/DanielRosenwasser
on Oct 6, 2022https://github.com/microsoft/TypeScript/issues/51086#issuecomment-1270531686
Daniel Rosenwasser (DanielRosenwasser)https://github.com/DanielRosenwasser
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
Domain: JSDocRelates to JSDoc parsing and type generationhttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Domain%3A%20JSDoc%22
on Oct 6, 2022https://github.com/microsoft/TypeScript/issues/51086#event-7537786704
https://github.com/a-tarasyuk
Oleksandr Tarasiuk (a-tarasyuk)https://github.com/a-tarasyuk
on Oct 6, 2022https://github.com/microsoft/TypeScript/issues/51086#issuecomment-1270569576
Nathan Shively-Sanders (sandersn)https://github.com/sandersn
completedhttps://github.com/microsoft/TypeScript/issues?q=is%3Aissue%20state%3Aclosed%20archived%3Afalse%20reason%3Acompleted
#51753https://github.com/microsoft/TypeScript/pull/51753
on Jan 17, 2023https://github.com/microsoft/TypeScript/issues/51086#event-8248499995
https://github.com/DanielRosenwasser
Daniel Rosenwasser (DanielRosenwasser)https://github.com/DanielRosenwasser
on Jan 17, 2023https://github.com/microsoft/TypeScript/issues/51086#issuecomment-1385908753
Oleksandr Tarasiuk (@a-tarasyuk)https://github.com/a-tarasyuk
Sign up for freehttps://github.com/signup?return_to=https://github.com/microsoft/TypeScript/issues/51086
Sign in to commenthttps://github.com/login?return_to=https://github.com/microsoft/TypeScript/issues/51086
Domain: JSDocRelates to JSDoc parsing and type generationhttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22Domain%3A%20JSDoc%22
In DiscussionNot yet reached consensushttps://github.com/microsoft/TypeScript/issues?q=state%3Aopen%20label%3A%22In%20Discussion%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.