JSDOC @type tag crashes with simple export #36830

Activity

1. Ryan Cavanaugh (RyanCavanaugh)

   added

   BugA bug in TypeScriptA bug in TypeScript

   on Mar 10, 2020
2. Ryan Cavanaugh (RyanCavanaugh)

   assigned

   Orta Therox (orta)

   on Mar 10, 2020
3. Ryan Cavanaugh (RyanCavanaugh)

   added this to the TypeScript 3.9.0 milestone on Mar 10, 2020
4. orta commented on Apr 1, 2020

   

   Orta Therox (orta)

   on Apr 1, 2020

   Last edited by orta

   Contributor

   More actions

   Cool, reproduced with:

   // @allowJs: true
   // @noEmit: true
   // @checkJs: true
   
   // @filename: lib/index.js
   /** @type {import('../folder/index').zzz} */
   function xxx() {
     return null;
   }
   
   // @filename: folder/index.d.ts
   export function zzz(): string;

   In normal TypeScript code, you wouldn't write import('../folder/index').zzz - but would write typeof import('../folder/index').zzz to get to the type () => string - doing this doesn't cause the loop in the code.

   Which I think leads to another question, what should be the behavior here in JSDoc world? Do we assume we want the typeof to be assumed because you're using @type or does it still represent the export-ed identifier of zzz?
5. orta commented on Apr 1, 2020

   

   Orta Therox (orta)

   on Apr 1, 2020

   Contributor

   More actions

   Asked around, and the opinion is yes - we want to pretend there's a typeof before the import in this case - gonna pair on it next week
6. Daniel Rosenwasser (DanielRosenwasser)

   modified the milestones: TypeScript 3.9.0, TypeScript 3.9.1 on Apr 7, 2020
7. Orta Therox (orta)

   added 3 commits that reference this issue on May 4, 2020

   Only do an extra JSDoc type reference lookup when on a class - fixes m…

   ...

   This issue will close once commit 0fe7acc is merged into the 'master' branch.

   0fe7acc

   Only do an extra JSDoc type reference lookup when on a class - fixes m…

   ...

   This issue will close once commit 3f5726e is merged into the 'master' branch.

   3f5726e

   Only do an extra JSDoc type reference lookup when on a class - fixes m…

   ...

   This issue will close once commit 97db3b5 is merged into the 'master' branch.

   97db3b5
8. Orta Therox (orta)

   added

   Fix AvailableA PR has been opened for this issueA PR has been opened for this issue

   on May 4, 2020
9. Orta Therox (orta)

   added

   RescheduledThis issue was previously scheduled to an earlier milestoneThis issue was previously scheduled to an earlier milestone

   on May 12, 2020
10. Orta Therox (orta)

    modified the milestones: TypeScript 3.9.1, TypeScript 4.0 on May 12, 2020
11. Ryan Cavanaugh (RyanCavanaugh)

    modified the milestones: TypeScript 4.0, Typescript 4.0.1 on Jun 29, 2020
12. Orta Therox (orta)

    assigned

    Nathan Shively-Sanders (sandersn)

    on Jul 15, 2020
13. Yehyoung Kang (pastelmind)

    added a commit that references this issue on Jul 17, 2020

    fix(ts): Add typeof' in @type of assert

    ...

    016e766
14. Orta Therox (orta)

    removed their assignment

    on Jul 21, 2020
15. Nathan Shively-Sanders (sandersn)

    modified the milestones: TypeScript 4.0.1, TypeScript 4.1.0 on Jul 30, 2020
16. Ryan Cavanaugh (RyanCavanaugh)

    assigned

    Orta Therox (orta)

    and unassigned

    Nathan Shively-Sanders (sandersn)

    on Aug 18, 2020
17. Ryan Cavanaugh (RyanCavanaugh)

    removed

    RescheduledThis issue was previously scheduled to an earlier milestoneThis issue was previously scheduled to an earlier milestone

    on Aug 18, 2020
18. orta commented on Aug 18, 2020

    

    Orta Therox (orta)

    on Aug 18, 2020

    Contributor

    More actions

    A fix for this got merged yesterday: #39770

    👍React with 👍1Reacted by Rafał Chłodnicki
19. Orta Therox (orta)

    closed this as completedon Aug 18, 2020
20. microsoft

    locked as resolved and limited conversation to collaborators on Oct 21, 2025