Webstorm - TypeScript quick documentation/ for re-exported functions

I don't get documentation/ when I hover on a function that is re-exported in the original package  If I hold CTRL and then hover, it shows the inferred type which is what I want, but in the documentation, it doesn't show that.

 

Here I am hovering over `dom` (`etch/index` re-exports `dom` from `etch/dom`).:

 

Similar code inside Atom on just hover:

1
3 comments

Hmm...'etch' library doesn't include ts files, and no typings for this library are available, as far as I can see... Importing pure javascript libraries in .ts files is not recognized, i.e. no types resolving/completion/documentation are there

But your screenshot from Atom suggests that the typings are there... What module do you use namely? is it https://github.com/atom/etch? If yes, atom must have its own internal library stubs for this module that aren't available in the github repo and not included in module distribution

0

I should have mentioned that I am developing the types myself: https://github.com/aminya/etch/tree/type_definitions in this PR: https://github.com/atom/etch/pull/82. 

I have made a symbolic link from the etch library to the node_modules of atom-select-list. The file that you are seeing is the atom-select-list source from here:

https://github.com/aminya/atom-select-list/tree/TypeScript

0

Works for me in 2020.1 EAP that includes some quick doc improvements:

 

 

I've cloned your repo into node_modules and modified node_modules\etch\package.json so that it points to typings:

"types": "lib/index.d.ts",

See https://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html#including-declarations-in-your-npm-package

0

Please sign in to leave a comment.