How to document spread operator

[robcolburn]

How do we document object spread operators in functions

/**
 * @param {object} cat - cute
 * @param {function} blender - pokey
 * @param {array} cubes - things to pass to blender
 * @return {string}
 *   result of blender
 */
const doThing = ( {cat, blender}, ...cubes ) => blender(cat, ...cubes)

[lifenautjoe]

+1

[jtribble]

+1

[igor9silva]

+1

[brabeji]

Also please see #1163 , seems like code with spread operator can't be even parsed by jsdoc currently.

[ezzygemini]

+2

[igor9silva]

How is this solved nowadays?

[aliafshar]

@param {...object} myParam

works for me

JSDoc 3.4.3 (Thu, 10 Nov 2016 00:25:10 GMT)

[hegemonic]

See #987 and #1234 for examples of how to document this. I filed jsdoc/jsdoc.github.io#159 to add something about this to the docs.

[JanisE]

There is still no mention of the spread operator though, so I filed jsdoc/jsdoc.github.io#183 to add to the docs.

[axellbrendow]

I had a different need. I was doing my React component and I needed to document spread operator inside object destructuring. Seems that VSCode or JSDocs can not handle this properly.

I tried this way: (I've simplified)

/**
 * @typedef {{ value: number }} MyObj
 * @param {{ label?: string, rest: ...MyObj }} props
 */
const MyTextInput = ({ label, ...rest }) => {

But "rest" gets the weird type { rest: any, MyObj: any }. Yes, rest is considered as an object that has a property "rest" and another property "MyObj".

I also tried this way:

/**
 * @typedef {{ value: number }} MyObj
 * @param {{ label?: string, ...rest: MyObj }} props
 */
const MyTextInput = ({ label, ...rest }) => {

But "rest" gets the weird type { rest: MyObj }

So I found a solution that works for now:

/**
 * @typedef {{ value: number }} MyObj
 * @param {{ label?: string } & MyObj} props
 */
const MyTextInput = ({ label, ...rest }) => {

This time, "rest" type is correctly assigned to an object with the properties of MyObj.

[jimmywarting]

if i have something like this:

/**
 * @param {function} successCallback
 * @param {function} errorCallback
 * @param {SessionRequest=} sessionRequest
 */
function requestSession (successCallback, errorCallback, sessionRequest) {
  api.requestSession(successCallback, errorCallback, sessionRequest)
}

and i would want to just write

function request (...args) {
  api.requestSession(...args)
}

What would be the best way to write my jsdoc?

[raghav-misra]

if i have something like this:

/**
 * @param {function} successCallback
 * @param {function} errorCallback
 * @param {SessionRequest=} sessionRequest
 */
function requestSession (successCallback, errorCallback, sessionRequest) {
  api.requestSession(successCallback, errorCallback, sessionRequest)
}

and i would want to just write

function request (...args) {
  api.requestSession(...args)
}

What would be the best way to write my jsdoc?

Do correct me if I'm wrong but I think you could do:

/**
 * @param {function} successCallback
 * @param {function} errorCallback
 * @param {SessionRequest} sessionRequest
 */
function requestSession (...args) {
  api.requestSession(...args)
}

[tylim88]

/**
 * @param {...number} args - array of number arguments
 */
export const a = (...args: number[]) => {
	return args
}

this will works, but the parameter name is fixed to args

indirect source: https://jsdoc.app/tags-type.html