shims-vue.d.ts 不能扩展vue对象

我最近用ts+vue的过程中遇到了需要扩展vue对象的情况,通过@vue/cli 4.x生成项目,shims-vue.d.ts如下

declare module '*.vue' {
  import Vue from 'vue'
  export default Vue
}

declare module 'test-module'; //自己用js写的模块

想实现功能:通过 vue.minxin(SomeMixin) 了一个 全局mixin,提供了 a属性b方法,因此需要扩展Vue对象的定义使得ts编译不报错。
根据vue-cli官方文档如下
image.png

因此我想在shims-vue.d.ts里面直接对vue对象进行扩展,如下

import Vue from 'vue'
declare module 'vue/types/vue' {
 interface Vue {
   a: string;
   b: () => void
 }
}

declare module '*.vue' {
 export default Vue
}

declare module 'test-module'; //自己用js写的模块

最终结果 不但我想要的对象没有扩展上去,并且之前对*.vue的声明,自定义模块的声明等全部失效。
问题:

  1. 这种全局mixin怎么声明比较好
  2. 如果我想在shims-vue.d.ts里面对vue进行扩展该怎么做(貌似会对以前的声明产生影响)
  3. 为什么我这么修改shims-vue.d.ts会对*.vue文件的声明产生影响

谢谢各位大佬,问题困扰挺久了,找了各种资料,感觉自己还是每太想明白!!

阅读 8.1k
2 个回答

image.png

务必要写 declare module 里面,写里面写外面是截然不同的意思……

新手上路,请多包涵

声明模块 declare module 'xxxx'; 必须在顶级的scope里,如果文件头部出现了import 就代表不是顶级的scope了,此时就是 ts的模块补充,模块补充只能必须补充已经存在的 module 不能声明新的 module;相关知识 ts 模块补充文档

解决办法:把vue的扩展补充放到一个单独的文件

// 例如 新建一个 my-property.d.ts 同级的 my-property.d.ts 文件
import Vue from 'vue'
declare module 'vue/types/vue' {
 interface Vue {
   a: string;
   b: () => void
 }
}
撰写回答
你尚未登录,登录后可以
  • 和开发者交流问题的细节
  • 关注并接收问题和回答的更新提醒
  • 参与内容的编辑和改进,让解决方法与时俱进
推荐问题