vuex 动作和 jsdoc：如何标记注入的函数参数

Question

典型的 vuex 动作是：

const actions = {
  /**
   * @param {ActionContext} context passed by vuex
   * @param {Object} payload
   * @return {void}
   */
  myAction(vuexContext, payload) {...}
}

vuexContext为我注入的地方，在应用程序中我会像myAction(payload)一样使用这个函数。但是对于那种情况，我的 WebStorm IDE 抱怨参数数量无效。

也许有一些解决方法？

Answer 1

您可以尝试将 context 参数标记为可选：

/**
     * @param {ActionContext} [vuexContext]
     * @param {Object} payload
     * @return {void}
     */
    myAction(vuexContext, payload) {}

也请为相关功能请求投票：WEB-29740

vuex 动作和 jsdoc：如何标记注入的函数参数

vuex actions and jsdoc: how to mark injected function parameter

jsdoc

webstorm

vue.js

vuex