README.md

Eventra

Eventra is a lightweight, but powerful JavaScript/TypeScript event manager that comes with built in Type Support and browser/node.js compatibility. Eventra is designed to closely resemble Node.JS Event Emitters so that you can very easily and quickly switch between the two.

Type Safety

With the ability to use this library with in TypeScript, we have given you the ability to add type definitions directly into the Event Emitter. Once you have added your types, you can very quickly and very easily begin using your type safe events.

Type Safe Implementation

// Declare your events interface
interface MyEvents {
  'greeting': (message: string) => void;
}

const eventra = new Eventra<MyEvents>();

// Create your event listener
eventra.on('greeting', (msg) => {
  console.log("Received a greeting message:", msg);
});

// Emit your new event
eventra.emit('greeting', "Hello User");

JavaScript Implementation

To implement this into your JavaScript application, it is a very similar process to the one listed above. Simply declare your event emitter and start using it.

Plain JavaScript example

const { Eventra } = require('@duxcore/eventra'); 
const eventra = new Eventra();

// Create your event listener
eventra.on('greeting', (msg) => {
  console.log("Received a greeting message:", msg);
});

// Emit your new event
eventra.emit('greeting', "Hello User");

Browser Implementation

When we ship this library, we also ship it with a bundled version so that you may simply slot it into the browser. To do so you can use the Eventra namespace and call the class from that. Here is an example as such:

Browser Example

<script src='https://cdn.jsdelivr.net/gh/duxcore/eventra@latest/dist/eventra.min.js'></script>
<script>
  const eventra = new Eventra.Eventra();

  eventra.on("interval", () => {
    console.log("Interval Event Triggered");
  });

  eventra.once("singular", () => {
    console.log("Singular Event Triggered");
  });
  
  setInterval(() => {
    eventra.emit('interval');
    eventra.emit('singular');
  }, 1000)

</script>

This package uses discordjs/collection as the internal storage controller and is distributed with each copy of this library.