1,781 questions
0
votes
2
answers
69
views
Extending class and assigning different value to an existing property
I'm trying to extends a class and assign a different value for a property that has been already defined in the parent class. The new value is from the allowed values:
/** @typedef {'a'|'b'|'c'} Letter ...
- 3,183
1
vote
1
answer
110
views
How to add doc comments for variables returned from a function call?
Suppose I have a function like this:
function useFrobnaticator() {
return (stringToFrobnicate: string) => {
console.log(stringToFrobnicate.length > 20 ? '(too long)' : stringToFrobnicate);
...
- 6,936
1
vote
0
answers
74
views
How to provide shared JSDoc documentation for all function signature overloads in TypeScript?
I have this code
/**
* One
*/
function debounce(callback: AnyFunction, immediate?: boolean): void
/**
* Two
*/
function debounce(callback: AnyFunction, options: Options, immediate?: boolean): void
...
- 32.7k
Tooling
0
votes
2
replies
75
views
VUE-PHP navigation in PHPStorm
From PHP you can navigate to VUE component from Inertia call. I have paid Laravel Idea plugin installed.
But I can not navigate from VUE component to PHP controller or it's method.
In VUE file I have ...
- 33
0
votes
0
answers
44
views
How does the GJS documentation pipeline work with DevDocs?
I’ve noticed that GJS documentation uses DevDocs.
I’m trying to understand the documentation pipeline for GJS:
Does it read comments from the source code and generate documentation automatically?
Do ...
- 56
2
votes
1
answer
128
views
Is there a way for JSDoc comments to be visible in HTML files?
I'm not sure how to get the code snippet for this question as I don't know how to specify the filename of the JavaScript file, but here goes.
I have a JavaScript file, "scripts.js" that ...
- 268
0
votes
0
answers
97
views
Why does TS remove JSDoc when creating type declaration file from JS file?
When I create a type declaration file (.d.ts) from a TypeScript file that includes JSDoc, the final type declaration file still contains the JSDoc. This is helpful, because the user of the package not ...
- 2,044
1
vote
0
answers
128
views
VSCode only checks JSDoc in files that are currently open. How do I make it check the entire project?
Currently, VSCode only recognizes JSDoc @typedef declarations in files that are open.
For example, if I have a @typedef comment in a file that is NOT currently open in VSCode, VSCode thinks the type ...
- 4,104
1
vote
1
answer
150
views
How to type destructured rest params with JSDoc for use with TypeScript?
I have a React component that takes props a, b, and any other arbitrary value the user wants to add on top:
/**
* @param {object} props
* @param {string} props.a
* @param {number} props.b
*/
...
- 1,140
1
vote
2
answers
90
views
React.memo() prevents jsdoc description to show up in vscode, is there a work around?
When exporting my component like this
export default React.memo(MyComponent);
and using it somewhere else like this
<MyComponent></MyComponent>
it will not show the jsdoc documentation of ...
- 1,057
2
votes
0
answers
155
views
How would you use JSDoc for VSCode intellisense on an extended class method
I'm working on a library, and would like some functionality that requires users (meaning the user of the library) to extend a class. On that class will be a method that the user should override, and ...
- 707
1
vote
1
answer
70
views
Optional class property for object
I want to be able to define objects as:
/**@type{CheckData}**/
object1 = {check:true}
/**@type{CheckData}**/
object2 = {check:false, data: 'Why?'}
While I can use this @typedef with success:
/**
* @...
- 362
0
votes
0
answers
29
views
How to type static getters in abstract classes in javascript using jsdoc
I've got a base class with some static getters that need to be overwritten by the inheriting classes.
class BaseClass {
/**
* @abstract
* @returns {string}
*/
static get prefix()...
- 1,085
0
votes
1
answer
152
views
How to get JSDOC to work with Vite alias?
Working with React 17 & Vite v5 & VS Code IDE
We want to use alias when importing components for ease of use. But when we use it, the jsDoc popup doesn't show any data.
How to configure jsDoc ...
- 23
0
votes
1
answer
50
views
Can @typedef describe objects partially
I have a message object that can have all kinds of keys, some of which I know, some of them I can't know.
// @ts-check
/**
* @typedef {Object} Message
* @property {String} sender
* @property {...
user3905522
