使用 TypeScript 向 Vue 3 添加全局属性

Question

我想向 Vue 3 应用程序添加一个全局属性，如建议的 here

原型方法不适用于 TypeScript。

我找到了一个示例，我将其转换为 config.d.ts 代码

import Vue from 'vue'

import base from '@/config/config.json'
import dev from '@/config/config.dev.json'
import prod from '@/config/config.prod.json'

let config
if (process.env.NODE_ENV === 'production') {
  config = Object.freeze(Object.assign(base, prod))
} else {
  config = Object.freeze(Object.assign(base, dev))
}

declare module 'vue/types/vue' {
  interface Vue {
    $config: config
  }
}

我想加载一些具有 dev 或 prod 范围的本地配置文件。范围内的文件不会被检入 GIT 存储库。

main.ts 现在看起来像这样...

import Vue from 'vue'
import {createApp} from 'vue'
import App from './App.vue'
import Config from '@/plugins/config.d.ts'

Vue.use(Config)
createApp(App).mount('#app')

问题：

ERROR in src/main.ts:6:5
TS2339: Property 'use' does not exist on type 'typeof import("d:/Martin/Entwicklung/2020/STA-Electron/node_modules/vue/dist/vue")'.
    4 | import Config from '@/plugins/config.d.ts'
    5 |
  > 6 | Vue.use(Config)
      |     ^^^
    7 | createApp(App).mount('#app')
    8 |

我理想中想要实现的是一个全局的config或$config属性，可以在Vue 3的setup方法中使用

export default defineComponent({
  name: 'App',
  components: {},
  setup(props, context) {
    const elem = ref(context.$config.prop1)
    const doSth = () => {
      console.log('Config', context.$config)
    }
    return {doSth, elem}
  },
})

我该如何解决这个问题？

更新

在 danielv 的回答之后，新插件看起来是这样的

import {App} from 'vue'

export interface ConfigOptions {
  base: any
  dev: any
  prod: any
}

export default {
  install: (app: App, options: ConfigOptions) => {
    app.config.globalProperties.$config =
      process.env.NODE_ENV === 'production'
        ? Object.freeze(Object.assign({}, options.base, options.prod))
        : Object.freeze(Object.assign({}, options.base, options.dev))
  },
}

main.ts 也改成了这个

import {createApp} from 'vue'
import App from '@/App.vue'
import ConfigPlugin from '@/plugins/config'
import base from '@/config/config.json'
import dev from '@/config/config.dev.json'
import prod from '@/config/config.prod.json'

createApp(App).use(ConfigPlugin, {base, dev, prod}).mount('#app')

这个简单的插件可以在模板中使用

<template>
  <img alt="Vue logo" src="./assets/logo.png" />
  <p>{{ $config.prop1 }}</p>
</template>

IntelliJ 抱怨未知变量 prop1，但它可以工作。

我搜索了很多，但没有办法将我的 $config 插入与组合 API 一起使用的设置方法中。

Answer 1

您可以在应用程序中扩充@vue/runtime-core TypeScript 模块：

declare module '@vue/runtime-core' {
  interface ComponentCustomProperties {
    $config: Record<string, unknown>;
  }
}

类似于 Vue 2 中的 used to work。

似乎这还没有进入 Vue 3 文档，但在 vuejs/vue-next#982 中引入。查看ComponentCustomProperties interface source code 了解更多信息。

Answer 2

在 Vue 3 中，您在应用实例上调用 use 方法，它不是 Vue var 上的方法。

const app = createApp(App)
app.mount('#app')
app.use(config)

此外，您需要编写您的插件以符合 Vue 3 的预期（具有install 方法的对象）。

查看Vue 3 guide 关于编写和使用插件的内容，它描述了一个与您非常相似的用例。

顺便说一句，*.d.ts 文件旨在用作纯声明文件来声明类型，通常作为对其他无类型模块的补充（例如，键入现有的 js 代码）。编写Typescript代码时一般不需要自己编写*.d.ts文件（声明可以由tsc编译器自动生成）。