How to document array elements in jsdoc?

Vishal Jangid 0
Viewed 31

I have a function that returns an array of two element. For given comments, VS code Intellisense is working fine, but when I generate docs using jsdoc, It throws the error.

ERROR: Unable to parse a tag's type expression for source file ... with tag title "returns" and text "{[state: initialState, dispatch: Function]}.

/** 
 * @typedef {object} initialState
 * @property {string} locator_id - ID 
 * @property {boolean} loading - 
*/

/**
 * @namespace Context
 * 
 * @returns {[state: initialState, dispatch: Function]} 
 */
jsdoc javascript
2 Answers

You can use:

/**
    @typedef AR_INNERJOIN
    @type {Set}
    @property {string} Lorem ipsum dolor sit amet, consectetur adipiscing elit. Cras at feugiat enim, eu mattis turpis. Duis suscipit, libero eu sagittis faucibus, velit urna pulvinar ex, sit amet sollicitudin leo dui in arcu.
*/

/**
 * sample inner join set
 * @type {AR_INNERJOIN}
 */
this.internalConnections = new Set();
ssb0

The JSDoc syntax for an array of object is:

/**
 * Description here...
 * @returns {Array.<{state: initialState, dispatch: Function}>}
 */
usertSXN0
Related