Suggestion: Add support for jsdoc-based templates with constrains #24283

Activity

1. mhegazy commented on May 21, 2018

   

   Mohamed Hegazy (mhegazy)

   on May 21, 2018

   Contributor

   More actions

   I think this should be:

   /**
    * @template T {number}
    * @param a {T}
    */
   function foo(a) { }

   👍React with 👍2Reacted by Nathan Shively-Sanders and Brendan Kenny
2. Mohamed Hegazy (mhegazy)

   added

   SuggestionAn idea for TypeScriptAn idea for TypeScript

   Domain: JSDocRelates to JSDoc parsing and type generationRelates to JSDoc parsing and type generation

   Salsa

   on May 21, 2018
3. Mohamed Hegazy (mhegazy)

   assigned

   Nathan Shively-Sanders (sandersn)

   on May 21, 2018
4. Mohamed Hegazy (mhegazy)

   added this to the TypeScript 3.0 milestone on May 21, 2018
5. brendankenny commented on May 21, 2018

   

   Brendan Kenny (brendankenny)

   on May 21, 2018

   Last edited by brendankenny

   Contributor

   More actions

   Definitely would be helpful. Right now we're using /** @type {...} */ to use bounded generics in js (either defined inline or in an external d.ts file), but that has some serious drawbacks at the moment.

   e.g. @type doesn't work on class methods, so we end up assigning the function to the prototype outside of the class body. It's also limited in scope to what's being immediately typed, unlike @template/generics in actual TS, so you can't really apply the type parameters across a whole class, for instance.

   Readability is also not a small concern (all crammed into that @type comment :), and being able to declare as regular @params, etc jsdoc tags would be fantastic.

   Compatibility with future Closure support isn't super important to us, at least, as we use enough TS-specific features (typeof, indexed access) that we have to do a cleaning pass on the code before passing to Closure anyways. If the solution is reasonable (like the above suggestion), there's also no reason Closure can't adopt it anyways.

   👍React with 👍1Reacted by Jan Nicklas
6. sandersn commented on Jun 4, 2018

   

   Nathan Shively-Sanders (sandersn)

   on Jun 4, 2018

   Member

   More actions

   #24600 has this change.

   👍React with 👍1Reacted by Jan Nicklas
7. Mohamed Hegazy (mhegazy)

   added

   FixedA PR has been merged for this issueA PR has been merged for this issue

   on Jun 4, 2018
8. Nathan Shively-Sanders (sandersn)

   closed this as completedin #24600on Jun 4, 2018
9. microsoft

   locked and limited conversation to collaborators on Aug 3, 2018