microsoft / microsoft/TypeScript
JSDoc property description containing "@" character seems to make everything below this as undefined
Open
@orta is already working on this.
Since Nov 3, 2020.
Bug
Domain: JSDoc
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
This is an issue with TS typings declarations generated from JSDoc and code analysis
TypeScript Version: 3.8.3
Search Terms: jsdoc property at @ description link markdown
Code
/**
* @typedef SomeTypeDef
* @property {string} property1
* I'm a comment with an [@s](link)
* @property {boolean} propertyCantBeAccessed
*/
/**
* @param {SomeTypeDef} s
*/
const f = (s) => {
s.propertyCantBeAccessed
}
f({
property1: 'only exists here',
propertyCantBeAccessed: false
})
Expected behavior:
The property exists and can be accessed
Actual behavior:
Code fails with Property 'propertyCantBeAccessed' does not exist on type 'SomeTypeDef'
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.