首页 > 解决方案 > 如何 jsDoc 原型在整个项目中的可见性?

问题描述

我正在尝试对这段代码做一些 jsDoc:

/**
 * @typedef {object} GameSmartAPI
 * @property {object} $api
 */

/** @type {GameSmartAPI} */
Vue.prototype.$api = { 
  myMethod() { /* Do stuff */ }
}

然后我在另一个文件中使用它,如下所示:

new Vue({
  el: '#app',
  mounted() {
    this.$api.myMethod()
  },
  render: h => h(index)
})

这不是this.$api项目中的选择。所以,我想做的是记录原型$api,以便其他文件知道是什么$api。目前它不知道是什么this.$api,我收到一个编辑器错误,上面写着:

属性 '$api' 不存在于类型 'ComponentOptions<Vue, DataDef<Data, Record<PropNames, any>, Vue>, Methods, Computed, Array<PropNames>, Record<PropNames, any>> & ThisType<CombinedVueInstance< Vue、数据、方法、计算、只读<...>>>'

标签: javascriptvue.jsjsdoc

解决方案


推荐阅读