microsoft / microsoft/TypeScript
Support typedef inheritance with JSDoc
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
TypeScript Version: 2.7.0-dev.20171116
Code
/**
* @typedef {Object} Base
* @property {String} baseProp
*/
/**
* @typedef {Base} Child
* @property {String} childProp
*/
/** @type {Child} */
const child = { baseProp: '' };
Expected behavior: Error. child is missing the childProp property.
Actual behavior: No error. The Child type is identical to the Base type and only requires a baseProp property. The childProp property definition is completely ignored.
Or maybe there's another way to do the equivalent of interface Child extends Base here?
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.
Research direction
Start by reproducing the JSDoc typedef example from the issue and trace TypeScript's handling of typedef inheritance and @property declarations. Done means the checker reports that Child is missing childProp, or documents and implements the supported equivalent of interface Child extends Base.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, typescript
- Domain
- compilers
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100