return-in-emits-validator.md

pageClass	sidebarDepth	title	description	since
rule-details	0	vue/return-in-emits-validator	enforce that a return statement is present in emits validator	v7.0.0

vue/return-in-emits-validator

enforce that a return statement is present in emits validator

• ⚙️ This rule is included in all of "plugin:vue/vue3-essential", *.configs["flat/essential"], "plugin:vue/essential", *.configs["flat/vue2-essential"], "plugin:vue/vue3-strongly-recommended", *.configs["flat/strongly-recommended"], "plugin:vue/strongly-recommended", *.configs["flat/vue2-strongly-recommended"], "plugin:vue/vue3-recommended", *.configs["flat/recommended"], "plugin:vue/recommended" and *.configs["flat/vue2-recommended"].

📖 Rule Details

This rule enforces that a return statement is present in emits validators.

<script>
export default {
  emits: {
    /* ✓ GOOD */
    foo(evt) {
      if (evt) {
        return true
      } else {
        return false
      }
    },
    bar: function () {
      return true
    },
    baz(evt) {
      if (evt) {
        return true
      }
    },
    /* ✗ BAD */
    qux: function () {},
    quux(evt) {
      if (!evt) {
        return false
      }
    }
  }
}
</script>

🔧 Options

Nothing.

📚 Further Reading

• Guide - Custom Events / Validate Emitted Events
• Vue RFCs - 0030-emits-option

🚀 Version

This rule was introduced in eslint-plugin-vue v7.0.0

🔍 Implementation

• Rule source
• Test source