How to use jsdoc to declare what properties a return value contains?

Question

I know that I can use jsdoc to declare that a function returns an Object.

/**
 *  Builds a body that returns published products
 * @param {string} rangeType
 * @param {string} retailUnit
 * @param {string[]} ids
 * @returns {Object}
 */
function fetchPublishedProducts(rangeType, retailUnit, ids) {
  return {
    size: 250,
    query: {
      ids: {
        values: ids.map(id => `${id}-${retailUnit}${rangeType ? `_${rangeType}` : ''}`),
      },
    },
  };
}

But what is the syntax if I want to declare that the return object has a size and a query property?

Does this answer your question? [How to describe "object" arguments in jsdoc?](https://stackoverflow.com/questions/6460604/how-to-describe-object-arguments-in-jsdoc) — jonrsharpe, Nov 11 '20 at 15:02

Mr. R · Accepted Answer · 2020-11-11T19:13:44.957

1

Just define your object interface as:

/**
 * ....
 * @returns {{size: number, query: string}}
 */

edited Nov 11 '20 at 19:13

answered Nov 11 '20 at 15:15

Mr. R

955
1
4
13

How to use jsdoc to declare what properties a return value contains?

1 Answers1