Pergunta sobre Vue 3 + TypeScript e Augmenting-Types-for-Use-with-Plugins

Sep 29 2020

Alguém sabe de um exemplo prático de como o aumento de tipo deve ser implementado com Vue3 e TypeScript? Tenho tentado seguir os docs do Vue2 em aros de usar o mesmo no Vue3 sem sucesso e gasto as últimas 3 horas de pesquisa sem nenhum resultado.

Parece que o Vueobjeto no vue-class-componentmódulo deve ser aumentado para funcionar, mas como?

Minha implementação é semelhante à seguinte:

Algum conselho?

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");

Respostas

A.Terra Jan 19 2021 at 03:25

Pelo que entendi, vue-class-componentainda não oferece suporte total ao Vue 3. Eles ainda estão discutindo modificações na biblioteca. Então, não sei se os exemplos abaixo funcionarão com ele, mas isso é o que fiz para aumentar os tipos de plug-in.

ola.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;
  }
}

Eu declarei o tipo no próprio arquivo do plugin, mas você também pode declará-los no shims-vue.d.tsarquivo.

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>