> For the complete documentation index, see [llms.txt](https://docs.opensoutheners.com/home/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.opensoutheners.com/home/vue-3-emitter/usage.md).

# Usage

There are multiple ways to use vue3-emitter on your project, you can choose the one you prefer at any time.

### subscribe

Subscribe to an event returns a function to unsubscribe that handler/listener to that same event.

```vue
<template>
  <!-- Your template here... -->
</template>

<script>
import { emitter } from "vue3-emitter"

export default {
  data() {
    return {
      subscription: null,
    }
  },

  mounted() {
    this.subscription = emitter.subscribe("my_event", (payload) => {
      console.log({ payload })
    })
  },

  beforeUnmount() {
    if (this.subscription) {
      // This will unsubscribe before the component is being removed from the VDOM...
      this.subscription()
    }
  }
}
</script>
```

### listen

Listen does the same as subscribe but does handle the component lifecycle by its own, whenever the component is being removed by Vue the global event subscription will be removed.

**Remember this is important for prevent memory leaks from your application.**

```vue
<template>
  <!-- Your template here... -->
</template>

<script>
import { emitter } from "vue3-emitter"

export default {
  setup() {
    emitter.listen("my_event", (payload) => {
      console.log({ payload })
    })
  }
}
</script>
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.opensoutheners.com/home/vue-3-emitter/usage.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.