Nuxt.js Typescript - 尝试访问计算属性中的数据对象时出错

Question

我正在使用选项 api，当尝试访问计算属性中的 Vue 数据对象的属性时，我在类型检查中遇到错误。

Property 'quantity' does not exist on type 'CombinedVueInstance<Vue, unknown, unknown, { item: unknown; total: unknown; menuItemCategories: any; }, Readonly<Record<never, any>>>'

该属性确实存在，因为页面能够使用计算属性正确加载和显示渲染模板 - 只有类型检查器会抱怨。

组件代码（长度简化）：

import Vue from "vue";
export default Vue.extend({
  data() {
    quantity: 1,
  },

  computed: {
    total() {
      return this.item.price * this.quantity;
    }
  },
});

编辑

我已经能够通过将data 属性用作对象来解决此问题。

这确实会产生一些问题，因为最佳实践是使用data 作为返回对象的函数。同样的问题也适用于asyncData。

进一步的试验和错误表明我能够通过methods 属性访问data 函数属性。但是，如果我使用来自 vuex 的 mapGetters 助手，它会引发与计算属性相同的类型错误。

methods 在计算属性内的 CombinedVueInstance 类型中也不可用。

tsconfig.json

// tsconfig.json
{
  "compilerOptions": {
    "target": "es2018",
    "module": "esnext",
    "moduleResolution": "node",
    "lib": [
      "esnext",
      "esnext.asynciterable",
      "dom"
    ],
    "esModuleInterop": true,
    "allowJs": true,
    "sourceMap": true,
    "strict": true,
    "noEmit": true,
    "baseUrl": "./src",
    "paths": {
      "~/*": [
        "./*"
      ],
      "@/*": [
        "./*"
      ]
    },
    "types": [
      "@types/node",
      "@nuxt/types",
      "@nuxtjs/axios"
    ]
  },
  "exclude": [
    "node_modules"
  ]
}

vue-shim.d.ts

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

Answer 1

使用 Nuxt Typescript 的类型检查有一些奇怪的行为，因为它无法正确推断所有类型。这通过使用 Vuex vanilla 和辅助函数进一步复杂化。

要以最少的样板获得完整的类型信息，最好使用vue-class-component 和vue-property-decorator，如Nuxt Typescript docs - Components 所示（请参阅类API），以及基于类的vuex-module-decorators 请参阅Nuxt Typescript Docs - Store。

但是，要在仍然使用选项 API 的同时回答解决此问题的原始问题 - 您必须在 computed 和 methods 中声明所有函数的返回类型；并根据需要强制 Vuex 辅助函数。

不幸的是，我们仍然没有对asyncData 进行正确的类型检查，因此我们必须在data 和asyncData 函数之间复制我们的代码。

import Vue from "vue";
import { mapGetters } from "vuex";

export default Vue.extend({
  // Default component data - supports type checking
  data() {
    return {
      quantity: 1,
    }
  },

  // Actual component data - sourced from api
  async asyncData() {
    const theAwaitedQuantity = // ... some await methods and promises from a backend api
    return {
      quantity: theAwaitedQuantity,
    }
  },

  computed: {
    ...mapGetters(["item"]),

    total(): number {
      // mapped properties from helper functions must have their types coerced.
      return (this.item as ItemType).price * this.quantity;
    }
  },

  methods: {
    someMethod(): string {
      return "methods also need their return type defined";
    }
  }
});

另请参阅此相关问题： Property 'XXX' does not exist on type 'CombinedVueInstance<Vue, {}, {}, {}, Readonly<Record<never, any>>>'