Document JSDoc imports with generics #1106

Activity

1. andrewrlee commented on Oct 19, 2019

   

   Andrew Lee (andrewrlee)

   on Oct 19, 2019

   More actions

   Thank-you, this helped me loads after a lot of searching.

   I'm new to JSDoc and using vscode. Another gotcha for me was that this restricts typeDef other types in the same jsdoc as a template variable:

   The following makes Bob generic too:

   /**
    * @template T
    * @typedef {import("../types").ThunkAction<T>} ThunkAction<T>
    * @typedef {import("../types").Bob} Bob
    */
   

   The following makes Bob generic and also adds a Cannot find name 'T' error:

   /**
    * @typedef {import("../types").Bob} Bob
    * @template T
    * @typedef {import("../types").ThunkAction<T>} ThunkAction<T>
    */
   

   It also seems like the second param on the type def is optional, as the following also works for me:

   /**
    * @template T
    * @typedef {import("../types").ThunkAction<T>} ThunkAction
    */
   

   I assume these aren't defects, but I found this quite confusing and additional documentation might help?

   👍React with 👍3Reacted by Greg Tatum, Jarosław Bagnicki and btoo
2. gregtatum commented on Oct 24, 2019

   

   Greg Tatum (gregtatum)

   on Oct 24, 2019

   Author

   More actions

   Thanks for clarifying some of those points Andrew Lee (@andrewrlee), I ran into some of those issues as well.
3. codingedgar commented on Dec 13, 2019

   

   Edgar Rodriguez (codingedgar)

   on Dec 13, 2019

   More actions

   Greg Tatum (@gregtatum) wow thank you so much!! 👏👏 👏

   👍React with 👍1Reacted by Greg Tatum
4. tjx666 commented on Feb 13, 2020

   

   YuTengjing (tjx666)

   on Feb 13, 2020

   More actions

   I want to know how to keep the generic when useing typedef to import:
   
5. sultan99 commented on Jun 6, 2020

   

   Sultan Arziyev (sultan99)

   on Jun 6, 2020

   Last edited by sultan99

   More actions

   YuTengjing (@tjx666)

   /** line 3
    * @template T
    * @typedef {import('./node').Node<T>} Node
    */
   
   . . . 
     / **                                      // line 15 
       * @template T
       * @type {Node<T> | undefined}
       */
     this.head = undefined                     // line 16