在JSDoc中记录未知的其他可选属性

时间:2018-12-31 15:23:46

标签: javascript jsdoc jsdoc3

我有一个接受一个对象参数的函数。
该对象的一个特定属性重要,而所有其他可能的属性将被忽略。
如何记录可选的其他属性?

  /**
   * does stuff
   *
   * @param {Object} data
   * @param {string} data.type - some description
   * @param {...any} [data.*] - <-- something like this
   */
  function foo(data) {
    if (data.type === ...)
    otherMethod(data)
  }

  foo({type: "FOO", size: 1, ...})

0 个答案:

没有答案