Vue 3 defineEmits 打破了 defineProps 类型

Question

我正在使用 Vue 3 和 TS 4.4。我有一个用defineProps 定义其道具类型的组件。当我添加对defineEmits 的调用时，VS Code 开始告诉我我的props 变量在组件模板中不存在。这是源代码：

<script setup lang="ts">
import { defineProps, defineEmits, VueElement, defineComponent } from "vue";

const emit = defineEmits<{
  "update:checked": boolean;
}>();

const props = defineProps<{
  label?: VueElement | string;
  checked?: boolean;
}>();
</script>

<template>
  <label>
    <input
      type="checkbox"
      :checked="props.checked"
      @change="(event) => emit('update:checked', (event.target as any)?.checked)"
    />
    {{ props.label }}
  </label>
</template>

还有几个屏幕截图可以更好地展示我在 VS Code 中看到的内容。这是在添加defineEmits之后：

这是没有defineEmits：

为 props 和 emits 定义类型的正确方法是什么？

Answer 1

defineEmits<T>() generic argument 本质上是一个 TypeScript 接口，它只定义了函数，它们接收特定的事件名称和可选参数：

interface Emits {
  (e: __EVENT1_NAME__ [, arg1: __ARG1_TYPE__ [, arg2: __ARG2_TYPE__]]...): void
  (e: __EVENT2_NAME__ [, arg1: __ARG1_TYPE__ [, arg2: __ARG2_TYPE__]]...): void
}

例子：

// as inline type
const emits = defineEmits<{
  (eventName: 'hover', hovering: boolean): void
  (eventName: 'changed', newValue: number, id: string): void
}>()

// as interface
interface Emits {
  (eventName: 'hover', hovering: boolean): void
  (eventName: 'changed', newValue: number, id: string): void
}
const emits = defineEmits<Emits>()

// as type alias
type Emits = {
  (eventName: 'hover', hovering: boolean): void
  (eventName: 'changed', newValue: number, id: string): void
}
const emits = defineEmits<Emits>()

对于您的update:checked 事件，代码应类似于以下内容：

// as inline type
const emits = defineEmits<{
  (e: 'update:checked', checked: boolean): void
}>()

// as interface
interface Emits {
  (e: 'update:checked', checked: boolean): void
}
const emits = defineEmits<Emits>()

// as type alias
type Emits = {
  (e: 'update:checked', checked: boolean): void
}
const emits = defineEmits<Emits>()