Missing documentation in VS Code

[Nomad-Soul]

Operating System

Windows 11

Programming Languages

JavaScript

CCXT Version

4.3.1

Description

In a NodeJS app, I have installed ccxt with npm i ccxt, and imported ccxt into a script with import ccxt, { Exchange } from 'ccxt';, however while intellisense provides me with a list of types and methods, it does not provide any documentation as to what each argument represents. But I see that the source has documentation showing. There seems to be also no @types/ccxt package like there is with other packages

This is what I see when I type "." on a ccxt exhange object.

I haven't seen any other additional steps to follow to get the documentation working in the manual, and all the other packages I am using do have the documentation showing up correctly.

Thanks for any help.

Code

[carlosmiei]

Hello @Nomad-Soul, thanks for reporting it, we will take a look, in the meantime you can access our docs here: https://docs.ccxt.com/#/

[ttodua]

@Nomad-Soul just for completeness, could you share reproducible tsconfig.json (if you use ) ?

[ttodua]

I get this:

as visible, it shows symbols and params

[ttodua]

@carlosmiei maybe you can re-assign this to SamGermain, because it would be jsdoc related

[ttodua]

We might need https://github.com/TypeStrong/typedoc

[Nomad-Soul]

I get this: as visible, it shows symbols and params

That's what I see too, but I meant that there is no documentation for what the parameters do or need.
The same information that is available on docs.ccxt.com:

Some methods seem to have jsdoc tags in the source code, but these are not visible through intellisense. Should those tags appear before the function signature? But indeed many of the main methods don't have any documentation.

[Nomad-Soul]

This is my jsconfig.json:

{
  "compilerOptions": {
    "module": "NodeNext",
    "target": "ES6",
    "checkJs": true,
    "moduleResolution": "nodenext",
    "lib": ["ES2022", "DOM"],
    "allowJs": true
  },
}