vue/prefer-single-event-payload

Enforce passing a single argument to custom event emissions.

Applies to: Vue SFC templates and blocks, with script context where the rule requires it.

Bad

The move event declares and emits two payload values, so an inline listener only receives x.

<script setup lang="ts">
const emit = defineEmits<{ move: [x: number, y: number] }>()
emit("move", 1, 2)
</script>
<template />

Good

The move event carries one object, so every listener receives both coordinates.

<script setup lang="ts">
const emit = defineEmits<{ move: [point: { x: number; y: number }] }>()
emit("move", { x: 1, y: 2 })
</script>
<template />

Configuration (Vite+)

import { defineConfig } from "@vizejs/vite-plugin/vite-plus";

export default defineConfig({}).withVue({
  linter: {
    "preset": "incremental",
    "rules": {
      "vue/prefer-single-event-payload": "warn"
    }
  },
});

Then run vp run lint.

Related

• Vue rules
• All rules
• Source code