【问题标题】:vuex actions and jsdoc: how to mark injected function parametervuex 动作和 jsdoc:如何标记注入的函数参数
【发布时间】:2018-08-02 22:40:43
【问题描述】:

典型的 vuex 动作是:

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

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

也许有一些解决方法?

【问题讨论】:

    标签: vue.js webstorm vuex jsdoc


    【解决方案1】:

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

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

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

    【讨论】:

    • 谢谢,我投票了。关于标记为可选,对于我来说,如果某些参数后面跟着必需的参数,则将其标记为可选有点不对。尤其是如果它确实不是可选的。但是我没有找到更好的选择。
    • 你是对的。但我建议了一个可行的解决方法。如果您找到更好的答案,请随时提供您自己的完美答案。
    • 刚刚检查了一下,这个解决方法不起作用。仍然有关于无效参数数量的警告¯\_(ツ)_/¯
    猜你喜欢
    • 1970-01-01
    • 2018-03-28
    • 2013-05-30
    • 2015-04-06
    • 1970-01-01
    • 2012-11-16
    • 2022-01-16
    • 2015-07-12
    • 2013-08-25
    相关资源
    最近更新 更多