I'm working on an JavaScript NPM library package and trying to get typescript to generate a .d.ts file from the jsdocs embedded in the file. Let's say I have the following three files: index.js, the main entry point into library:…
The following is an interface. /** * @interface */ class ISomething { /** * @return {number} */ static aMethod() { throw new Error('not implemented'); } /** * @type {Object} */ static property; } The following is an implementation, and no…
I have a function which takes in two parameters, something like: function example(type, val) { // handle "val" based on "type" } The acceptable types for val depend on type. The type parameter will always be one of a few…
How can JSDoc be used to type props of styled-components in combination with tsconfig.json and tsc. In TypeScript this is very easy with a simple generic, unfortunately I cannot achieve the same using JSDoc. I would imagine doing something like…
Problem I am finding that JSDoc works well with intellisense and type checking when the JSDoc-typed code is "inside" the project; however, including a JSDoc-typed library via a script tag (<script src="mylibrary.js">) does NOT provide any intellisense, type checking, or…
I recently added jsdocs to my project and since then I have eslint telling me that 'await has no effect on this kind of expression' const result = await someAsyncFunction(); // await has no effect console.log(result.property); Removing the await keyword…
I have added // @ts-check to a JavaScript file to use JSDoc. Suddenly I get errors in VS Code for functions included with a script tag: <script src="imported-file.js"></script> I can silence these by adding a lot of // @ts-ignore (or…
I can't seem to get JSDoc-based intellisense in VSCode to work for the Chart.js library. Reproducible scenario The steps are minimal and detailed below, but you can also clone my repository created with the steps from this question. I have…
I have the following LinkedList class definition using JSDoc and jsconfig.json for type checking in VSCode. In it it should display the type of value and next as union types with undefined, however it does not, only showing their default…
const objectname = { property: 0, set (value) { this.property = value; } } How would you document these example lines with JSDoc comments? This is what I already tried but it doesn't show objectName.set as a method and doesn't…