---
url: /docs/guide/usage/linter/rules/vue/define-emits-declaration.md
---

### 作用

强制 Vue 中 `defineEmits` 的声明风格保持一致。
此规则仅适用于 `lang="ts"` 的 `<script setup>`。

### 为什么这不好？

不一致的代码风格会让人困惑，并使代码更难阅读。

### 示例

以下是此规则的**错误**代码示例：

```vue
// "vue/define-emits-declaration": ["error", "type-based"]
<script setup lang="ts">
const emit = defineEmits(["change", "update"]);
const emit2 = defineEmits({
  change: (id) => typeof id === "number",
  update: (value) => typeof value === "string",
});
</script>

// "vue/define-emits-declaration": ["error", "type-literal"]
<script setup lang="ts">
const emit = defineEmits<{
  (e: "change", id: number): void;
  (e: "update", value: string): void;
}>();
</script>

// "vue/define-emits-declaration": ["error", "runtime"]
<script setup lang="ts">
const emit = defineEmits<{
  (e: "change", id: number): void;
  (e: "update", value: string): void;
}>();
</script>
```

以下是此规则的**正确**代码示例：

```vue
// "vue/define-emits-declaration": ["error", "type-based"]
<script setup lang="ts">
const emit = defineEmits<{
  (e: "change", id: number): void;
  (e: "update", value: string): void;
}>();
const emit2 = defineEmits<{
  change: [id: number];
  update: [value: string];
}>();
</script>

// "vue/define-emits-declaration": ["error", "type-literal"]
<script setup lang="ts">
const emit = defineEmits<{
  change: [id: number];
  update: [value: string];
}>();
</script>

// "vue/define-emits-declaration": ["error", "runtime"]
<script setup lang="ts">
const emit = defineEmits<{
  (e: "change", id: number): void;
  (e: "update", value: string): void;
}>();
const emit2 = defineEmits({
  change: (id) => typeof id === "number",
  update: (value) => typeof value === "string",
});
</script>
```

## 配置

此规则接受以下字符串值之一：

### `"type-based"`

强制使用命名的 TypeScript 类型或接口作为 `defineEmits` 的参数，例如 `defineEmits<MyEmits>()`。

### `"type-literal"`

强制使用内联类型字面量作为 `defineEmits` 的参数，例如 `defineEmits<{ (event: string): void }>()`。

### `"runtime"`

强制使用运行时声明，即通过数组或对象声明 emits，例如 `defineEmits(['event1', 'event2'])`。

## How to Use

## 版本

此规则于 v1.15.0 中添加。

## 参考资料