Category "jsdoc"

Forced symbol for the file with JSDoc `@name` returns an error that it does not exist

It is the code from the documentation (https://jsdoc.app/tags-name.html): // @ts-check /** * @name highlightSearchTerm * @function * @global * @param {strin

Construct signatures with JSDoc and TS-Pragma ts(2351)

I've a function that returns a constructor dynamically. When I try to instantiate the new object it warns me This expression is not constructable. Type 'myConst

Using JSDoc to set an index signature on an ES6 Class

In Typescript, you'd just do this: class Test { [key: string]: whatever } Which allows you to access computed property names like so... class Test { getPro

How to document a class as member of namespace

// in some file /** * @typedef myspace * @property {Object} models * @property {Object} services */ // in other files /** @typedef myspace.models.ModelA */

jsdoc error ENOENT: no such file or directory, open './readme/readme.md'

I have already installed jsdoc with npm i -D jsdoc command and created jsdoc.json file. In package.json file there is script called doc and after doing npm run

JSDoc nested types not showing on VSCode

I have this code: typedefs.js /** * A UUID. * Example: 123e4567-e89b-12d3-a456-426655540000 * * @typedef {string} uuid */ /** * @typedef {Object} Notific

How to document LWC Salesforce components public variables with JSDoc?

JSDoc skips my public LWC variables. Here is an example: /** * SomePublicVarName mode - default is false. * * @type {boolean} */ @a

JSDoc equivalent to Typescript's `as const`?

I'm in an old project that is too huge to easily convert to Typescript, so I've been using JSDoc instead. The Typescript feature that I can't figure out how to

Using an imported type in JSDoc @typedef

I'm trying to reduce duplication in specifying my imported types as follows but I'm getting an error /** @typedef {import("../types/util")} util @typedef {util.

Using an imported type in JSDoc @typedef

I'm trying to reduce duplication in specifying my imported types as follows but I'm getting an error /** @typedef {import("../types/util")} util @typedef {util.

Write JSdoc for generic function in typescript

I've distilled an essence of my problem with following codes: full source I have Base class, and Derived, Derived2: class Base { static get type() {

How to document destructured variable with jsdoc

I have something like this: let { total } = settings; How do I document the total variable? I tried something like this: /** * @type {Object} * @property

Is there a detailed documentation on how to create own jsdoc templates?

Short version: If I wanted to develop a completely new jsDoc template from scratch, what would I have to read to understand what jsDoc does, what interface my t