JSDoc中Object中任意键的值的文档结构

Question

我有一个函数工厂：

function factory(events) {
  for(const key in events) {
    const { before, after } = events[key]
  }
}

其中参数events通常是：

{
  only: {
    before(){}
    after(){}
  },
  except: {
    before(){}
    after(){}
  },
}

其中键只有，除了可以是任何值，但值总是（必须是）类型{前，后}其中前，后都是函数。

如何使用JSDoc在我的工厂函数中为事件参数记录这个结构？

我能想到的唯一解决方案是制作一个数组，然后我可以像这样使用typedef：

/**
 * @typedef event
 * @property {function} before
 * @property {function} after
 */
/**
 * @typedef eventTuple
 * @property {string} key
 * @property {event} event
 */
/**
 * @param {[eventTuple]} events
 */
function factory(events) {
  for(const { key, event } of events) {
    const { before, after } = event
  }
}

但是我真的想保留原来的结构。

是否可以在我的原始结构中记录此事件类型定义？

我主要关心的是它在VSCode中的工作，VSCode将这些类型定义从JSDoc中提升出来。

Answer 1

可以使用TS语法。

老实说，我不确定这是否在任何地方都有效。但至少对智能感知有用

js prettyprint-override">/**
 * @typedef event
 * @property {function} before
 * @property {function} after
 */

/**
 * @param {{[key: string]: event}} events
 */
function factory(events) {
    for (const key in events) {
        const { before, after } = events[key]
    }
}