> For the complete documentation index, see [llms.txt](https://docs.opensoutheners.com/oss/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/oss/vue-3-emitter/getting-started.md).

# Getting started

Install and get started with the library on your Vue 3 app

{% hint style="info" %}
More usage in details at [Using the library](https://github.com/open-southeners/docs.opensoutheners.com/blob/main/guide/usage.md), otherwise check the official documentation of mitt here: <https://github.com/developit/mitt/#api>
{% endhint %}

Install with the following command:

```sh
yarn add vue3-emitter
# or
npm i vue3-emitter
```

And for a basic usage of this library you can do the following example:

```js
import { emitter } from "vue3-emitter"

emitter.on("my_event", (payload) => console.log({ payload }))

emitter.emit("my_event", { hello: "world" })
```


---

# 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/oss/vue-3-emitter/getting-started.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.