← Back to rules

vue/no-deprecated-events-api Correctness

What it does

Disallow using deprecated Events API ($on, $off, $once) in Vue.js 3.0.0+.

Why is this bad?

In Vue.js 3.0.0+, the internal event APIs $on, $off, and $once have been removed. These methods were used for event handling between components but are no longer available.

Examples

Examples of incorrect code for this rule:

<script>
export default {
  mounted() {
    this.$on("event", () => {});
    this.$off("event");
    this.$once("event", () => {});
  },
};
</script>

Examples of correct code for this rule:

<script>
import mitt from "mitt";

const emitter = mitt();

export default {
  mounted() {
    emitter.on("event", () => {});
    emitter.off("event");
    emitter.once("event", () => {});
  },
};
</script>

How to use

To enable this rule using the config file or in the CLI, you can use:

Config (.oxlintrc.json)

{
  "plugins": ["vue"],
  "rules": {
    "vue/no-deprecated-events-api": "error"
  }
}

Config (oxlint.config.ts)

import { defineConfig } from "oxlint";

export default defineConfig({
  plugins: ["vue"],
  rules: {
    "vue/no-deprecated-events-api": "error",
  },
});

CLI

oxlint --deny vue/no-deprecated-events-api --vue-plugin

Version

This rule was added in v1.62.0.

References

• Rule Source
• Open rule in Oxc Playground