Frage zu Vue 3 + TypeScript und Augmenting-Types-for-Use-with-Plugins

Question

Kennt jemand ein funktionierendes Beispiel dafür, wie die Typerweiterung mit Vue3 und TypeScript implementiert werden sollte? Ich habe versucht, den Vue2-Dokumenten zu folgen, um sie in Vue3 ohne Erfolg zu verwenden, und die letzten 3 Stunden der Suche ohne Ergebnisse verbracht.

Es scheint, dass das VueObjekt im vue-class-componentModul erweitert werden sollte, um zu funktionieren, aber wie?

Meine Implementierung ähnelt der folgenden:

Irgendein Rat?

https://vuejs.org/v2/guide/typescript.html#Augmenting-Types-for-Use-with-Plugins

import { App, Plugin } from "vue";

export interface IHelloModule {
  sayHello: (name: string) => string;
}

export const helloPlugin: Plugin = (app: App, options) => {

  const helloModule:IHelloModule = {

    sayHello: function(name: string) {
      return `Hello ${name}`; } }; app.provide("$hello", helloModule);
};

import { Vue } from 'vue-class-component';
import { IHelloModule } from "@/hello";

declare module "vue/types/vue" {
  interface Vue {
    $hello: IHelloModule; } } declare module "vue/types/vue" { interface VueConstructor { $auth: IHelloModule;
  }
}

<template>
  <div class="home">
     .....
  </div>
</template>

<script lang="ts">
import { Options, Vue } from 'vue-class-component';

@Options({
  components: {
  },
})
export default class Home extends Vue {
  mounted() {
    console.log(this.$hello.sayHello("World"))
                     ^^^^^^^^^^^^^^^^^^^^^^^^^^
                     Neither TS nor vue-cli recognize this
  }
}
</script>

import { createApp } from "vue";
import App from "./App.vue";
import { helloPlugin } from "./hello";
import router from "./router";

createApp(App)
  .use(router, helloPlugin)
  .mount("#app");

Answer 1

Soweit ich vue-class-componentweiß , wird Vue 3 noch nicht vollständig unterstützt. Sie diskutieren immer noch Änderungen in der Bibliothek. Ich weiß also nicht, ob die folgenden Beispiele damit funktionieren, aber das habe ich getan, um Plugin-Typen zu erweitern.

hallo.plugin.ts

import { App } from "vue";

export interface IHelloModule {
  sayHello: (name: string) => string;
}

export default {
  install: (app: App) => {
    const helloModule: IHelloModule = {
      sayHello: function(name: string) {
        return `Hello ${name}`; } }; app.config.globalProperties.$hello = helloModule;
  }
}

declare module "@vue/runtime-core" {
  //Bind to `this` keyword
  interface ComponentCustomProperties {
    $hello: IHelloModule;
  }
}

Ich habe den Typ in der Plugin-Datei selbst deklariert, aber Sie können sie auch in der shims-vue.d.tsDatei deklarieren .

main.ts

import { createApp } from "vue";
import App from "./App.vue";
import router from "./router";
import Hello from "./hello.plugin";

createApp(App)
  .use(router)
  .use(Hello)
  .mount("#app");

Hello.vue

<script lang="ts">
import { defineComponent } from "vue";

const Hello = defineComponent({
  mounted() {
    console.log(this.$hello.sayHello("World"));
  }
});

export default Hello;
</script>