Title: JSDoc optional property in object · Issue #39906 · microsoft/TypeScript · GitHub
Open Graph Title: JSDoc optional property in object · Issue #39906 · microsoft/TypeScript
X Title: JSDoc optional property in object · Issue #39906 · microsoft/TypeScript
Description: TypeScript Version: 3.9.x & 4.1.x Search Terms: jsdoc optional There seems to be a regression since version 3.9.x where optional params in JSDocs are not converted correctly in declaration files. Several issues were created (linked below...
Open Graph Description: TypeScript Version: 3.9.x & 4.1.x Search Terms: jsdoc optional There seems to be a regression since version 3.9.x where optional params in JSDocs are not converted correctly in declaration files. S...
X Description: TypeScript Version: 3.9.x & 4.1.x Search Terms: jsdoc optional There seems to be a regression since version 3.9.x where optional params in JSDocs are not converted correctly in declaration file...
Opengraph URL: https://github.com/microsoft/TypeScript/issues/39906
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"JSDoc optional property in object","articleBody":"\r\n**TypeScript Version:** 3.9.x & 4.1.x\r\n\r\n\u003c!-- Search terms you tried before logging this (so others can find this issue more easily) -->\r\n**Search Terms:** jsdoc optional \r\n\r\nThere seems to be a regression since version 3.9.x where optional params in JSDocs are not converted correctly in declaration files. Several issues were created (linked below) and patches were made, however, it seems that **params nested inside objects** are still not correctly handled as optional when surrounded by brackets. \r\n\r\n**Code**\r\n\r\n```ts\r\n/**\r\n * Does Foo\r\n *\r\n * @param {object} opts\r\n * @param {string} [opts.bar] - is optional\r\n * @returns void\r\n */\r\nfunction foo(opts ) {\r\n // ..\r\n}\r\n```\r\n\r\n**Expected behavior: (as well as actual behavior \u003c=3.8.3)**\r\n```js\r\ndeclare function foo(opts: {\r\n bar?: string;\r\n}): void;\r\n```\r\n\r\n**Actual behavior:**\r\n```js\r\ndeclare function foo(opts: {\r\n bar: string;\r\n}): void;\r\n```\r\n\r\n**Related Issues:** \u003c!-- Did you find other bugs that looked similar? -->\r\nhttps://github.com/microsoft/TypeScript/issues/39111 was addressed with https://github.com/microsoft/TypeScript/pull/39487, but it doesn't seem that nested properties were covered in that fix.\r\nhttps://github.com/microsoft/TypeScript/pull/39123 and https://github.com/microsoft/TypeScript/pull/39457 seem to relate to Closure notation, not sure if they're related.\r\n","author":{"url":"https://github.com/mastermatt","@type":"Person","name":"mastermatt"},"datePublished":"2020-08-04T16:44:15Z","url":"https://github.com/microsoft/TypeScript/issues/39906"}
| react-profiling | 0 |
| react-import-map | react,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-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:fefea81e-defc-395e-7024-45aa11ab59fa |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | E526:1AE20C:A71D63:D4C1B3:6B00F277 |
| html-safe-nonce | 408402363e68eb97b72eec6c092a8e522dc89ba9b2fcacfaabf93071a5478f69 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJFNTI2OjFBRTIwQzpBNzFENjM6RDRDMUIzOjZCMDBGMjc3IiwidmlzaXRvcl9pZCI6IjcyNDQzMTc2MjkxMDY2ODA0MzkiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | 18f38c1d709ec4a61d40e61a0b642c6763e9f09b8ee030350783dcd78d853805 |
| hovercard-subject-tag | issue:672931372 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/microsoft/TypeScript/39906/issue_layout |
| twitter:image | https://opengraph.githubassets.com/580f4f3b4651096ea59e9f668dd01c65d9b46194b98577ec00c0c73193a16430/microsoft/TypeScript/issues/39906 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/580f4f3b4651096ea59e9f668dd01c65d9b46194b98577ec00c0c73193a16430/microsoft/TypeScript/issues/39906 |
| og:image:alt | TypeScript Version: 3.9.x & 4.1.x Search Terms: jsdoc optional There seems to be a regression since version 3.9.x where optional params in JSDocs are not converted correctly in declaration files. S... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | mastermatt |
| hostname | github.com |
| expected-hostname | github.com |
| None | 4ef498cbabcbe3c50befc7a5b743e7072ee770b4daf0e15e54801180d1fa91fc |
| turbo-cache-control | no-preview |
| go-import | github.com/microsoft/TypeScript git https://github.com/microsoft/TypeScript.git |
| octolytics-dimension-user_id | 6154722 |
| octolytics-dimension-user_login | microsoft |
| octolytics-dimension-repository_id | 20929025 |
| octolytics-dimension-repository_nwo | microsoft/TypeScript |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 20929025 |
| octolytics-dimension-repository_network_root_nwo | microsoft/TypeScript |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 9983dd5da06943f833c971dd5b6bc988e2858be5 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width