Vue 3 入門｜Emits Component Option

emits オプションはコンポーネントが発行するカスタムイベントの文書化を目的とした新しいオプションです。公式ドキュメントによれば、

It is highly recommended that you document all of the events emitted by each of your components using emits.

すべてのカスタムイベントを emits オプションで文書化することを推奨 しています。

emits オプションの定義方法は「配列」と「オブジェクト」の 2 種類あります。

<script>
export default {
  emits: ['toggle'],
}
</script>  

オブジェクトの定義方法はカスタムイベントの送信データの有効性を検証できます。

<script>
export default {
  emits: {
    toggle(value) {
      return typeof value === 'boolean'
    },
  },
}
</script>