Add named export, update README

Author: SplittyDev

README.md

@@ -8,34 +8,35 @@ Evee is a lightweight event library, written in clean JavaScript.
 Evee exports ESM, CommonJS and Browser globals, so you can use it in any environment.
 
 ## Upgrading to Evee 3
-Evee now natively supports ESM and CommonJS, so you can import it in any environment.
+Evee now natively supports ESM and CommonJS.
+
+We export two things:
+- `Evee` (default export): The class you can use to create new instances of Evee.
+- `evee` (named export): A pre-made instance of Evee so you can immediately start using it.
 
 If you're planning to use Evee in NodeJS, you can now import it like this:
 ```js
-import Evee from 'evee'; // If you're using ESM (import/export)
-const Evee = require('evee').default; // If you're using CommonJS (require)
+import Evee, { evee } from 'evee'; // If you're using ESM (import/export)
+const { default: Evee, evee } = require('evee'); // If you're using CommonJS (require)
 ```
 
 If you're planning to use Evee in the browser, you can now import it like this:
 ```html
 <!-- ESM if you're targeting modern browsers -->
 <script type="module">
-  import Evee from 'https://cdn.jsdelivr.net/npm/evee';
-  const evee = new Evee();
+  import Evee, { evee } from 'https://cdn.jsdelivr.net/npm/evee';
 </script>
 
 <!-- Global export if you're targeting older browsers -->
 <script src="https://cdn.jsdelivr.net/npm/evee/dist/browser/index.js"></script>
 <script>
-  const evee = new Evee(); // `Evee` is defined globally
+  // You can use the `Evee` (class) and `evee` (instance) globals here
 </script>
 ```
 
 ## How to use
 ```js
-import Evee from 'evee'
-
-const evee = new Evee()
+import { evee } from 'evee'
 
 // Subscribe to the 'update' event
 evee.on('update', e => console.log(`Received event #${e.data}`))
@@ -50,9 +51,7 @@ for (let i = 0; i < 100; i++) {
 You can also keep track of your event listeners unsubscribe from events you don't need anymore.
 
 ```js
-import Evee from 'evee'
-
-const evee = new Evee()
+import { evee } from 'evee'
 
 // Subscribe to the 'say' event
 var receiver = evee.on('say', e => console.log(e.data));
@@ -68,9 +67,7 @@ If you want to fire an event only once, you can do that too!
 The event will be automatically removed after the first usage:
 
 ```js
-import Evee from 'evee'
-
-const evee = new Evee()
+import { evee } from 'evee'
 
 // Subscribe to the 'say' event
 evee.once('say', e => console.log('hello, world'));

lib/evee.js

@@ -178,3 +178,5 @@ export default class Evee {
     this.receivers = [];
   }
 }
+
+export const evee = new Evee();

test.js

@@ -1,78 +1,82 @@
 // Grab assert and the evee module
 import assert from 'assert'
-import Evee from './dist/esm/index.js'
+import Evee, { evee } from './dist/esm/index.js'
 
-// Run tests with ES6 evee
-run_tests(Evee, "evee (node)");
+// Run tests with evee
+run_tests(() => new Evee(), "evee (node, new instance)");
+run_tests(() => {
+  evee.clear();
+  return evee
+}, "evee (node, shared instance)");
 
-function run_tests(Evee, name) {
+function run_tests(makeInstance, name) {
   describe(name, () => {
     describe('#on(name, action)', () => {
       it('should dispatch properly', () => {
-        var evee = new Evee();
+        const evee = makeInstance();
         var res = false;
         evee.on('a', _ => res = true);
         evee.signal('a');
         assert.equal(true, res);
       });
       it('should increment the id when subscribing', () => {
-        var evee = new Evee();
+        const evee = makeInstance();
         assert.equal(0, evee.on('a', _ => undefined).id);
         assert.equal(1, evee.on('b', _ => undefined).id);
         assert.equal(2, evee.on('c', _ => undefined).id);
       });
       it('should throw when the name is not a string', () => {
-        var evee = new Evee();
+        const evee = makeInstance();
         assert.throws(() => evee.on(undefined, () => undefined));
       });
       it('should throw when the action is not a function', () => {
-        var evee = new Evee();
+        const evee = makeInstance();
         assert.throws(() => evee.on('a', undefined));
       });
       it('should throw when called without arguments', () => {
-        var evee = new Evee();
+        const evee = makeInstance();
         assert.throws(() => evee.on());
       });
     });
     describe('#once(name, action)', () => {
       it('should only dispatch once', () => {
-        var evee = new Evee();
+        const evee = makeInstance();
         var res = false;
         evee.once('a', _ => res = !res);
         evee.signal('a', 'a');
         assert.equal(true, res);
       });
       it('should increment the id when subscribing', () => {
-        var evee = new Evee();
+        const evee = makeInstance();
         assert.equal(0, evee.once('a', _ => undefined).id);
         assert.equal(1, evee.once('b', _ => undefined).id);
         assert.equal(2, evee.once('c', _ => undefined).id);
       });
       it('should throw when the name is not a string', () => {
-        var evee = new Evee();
+        const evee = makeInstance();
         assert.throws(() => evee.once(undefined, () => undefined));
       });
       it('should throw when the action is not a function', () => {
-        var evee = new Evee();
+        const evee = makeInstance();
         assert.throws(() => evee.once('a', undefined));
       });
     });
     describe('#drop(event)', () => {
       it('should return true when subscriptions were removed', () => {
-        var evee = new Evee();
+        const evee = makeInstance();
         var ev = evee.on('a', _ => undefined);
         assert.equal(true, evee.drop(ev));
       });
       it('should throw when the argument is not an event object', () => {
-        var evee = new Evee();
+        const evee = makeInstance();
         assert.throws(() => evee.drop(0));
       });
       it('should throw when called without arguments', () => {
-        var evee = new Evee();
+        const evee = makeInstance();
         assert.throws(() => evee.drop());
       });
       it('should remove the right event', () => {
-        var evee = new Evee();
+        const evee = makeInstance();
         var resa = false;
         var resb = false;
         var eva = evee.on('a', _ => resa = true);
@@ -85,7 +89,7 @@ function run_tests(Evee, name) {
     });
     describe('#emit(name, data)', () => {
       it('should transmit the correct event data when dispatching', () => {
-        var evee = new Evee();
+        const evee = makeInstance();
         var res = 0;
         evee.on('a', e => res += e.data);
         evee.on('b', e => res += e.data);
@@ -94,50 +98,50 @@ function run_tests(Evee, name) {
         assert.equal(22, res);
       });
       it('should transmit the correct sender when dispatching', () => {
-        var evee = new Evee();
+        const evee = makeInstance();
         var res = false;
         var sender = evee.on('a', e => res = e.sender === sender);
         evee.emit('a');
         assert.equal(true, res);
       });
       it('should not dispatch when the event name matches no receivers', () => {
-        var evee = new Evee();
+        const evee = makeInstance();
         var res = false;
         evee.on('a', _ => res = true);
         evee.emit('b');
         assert.equal(false, res);
       });
       it('should dispatch when the event name matches a receiver', () => {
-        var evee = new Evee();
+        const evee = makeInstance();
         var res = false;
         evee.on('a', _ => res = true);
         evee.emit('a');
         assert.equal(true, res);
       });
       it('should dispatch when the event name matches multiple receivers', () => {
-        var evee = new Evee();
+        const evee = makeInstance();
         var res = 0;
         evee.on('a', _ => ++res);
         evee.on('a', _ => ++res);
         evee.emit('a');
         assert.equal(2, res);
       });
       it('should dispatch events with data', () => {
-        var evee = new Evee();
+        const evee = makeInstance();
         var res = false;
         evee.on('a', e => res = e.data);
         evee.emit('a', true);
         assert.equal(true, res);
       });
       it('should dispatch events without data', () => {
-        var evee = new Evee();
+        const evee = makeInstance();
         var res = false;
         evee.on('a', e => res = e.data === undefined ? true : false);
         evee.emit('a');
         assert.equal(true, res);
       });
       it('should dispatch multiple events with the same data', () => {
-        var evee = new Evee();
+        const evee = makeInstance();
         var resa = false;
         var resb = false;
         evee.on('a', e => resa = e.data);
@@ -147,7 +151,7 @@ function run_tests(Evee, name) {
         assert.equal(true, resb);
       });
       it('should dispatch multiple events with no data', () => {
-        var evee = new Evee();
+        const evee = makeInstance();
         var resa = true;
         var resb = false;
         evee.on('a', e => resa = e.data === undefined ? resa : !resa);
@@ -157,7 +161,7 @@ function run_tests(Evee, name) {
         assert.equal(true, resb);
       });
       it('should dispatch multiple events with different data', () => {
-        var evee = new Evee();
+        const evee = makeInstance();
         var resa = false;
         var resb = true;
         evee.on('a', e => resa = e.data);
@@ -167,13 +171,13 @@ function run_tests(Evee, name) {
         assert.equal(false, resb);
       });
       it('should throw when called without arguments', () => {
-        var evee = new Evee();
+        const evee = makeInstance();
         assert.throws(() => evee.emit());
       });
     });
     describe('#signal(...names)', () => {
       it('should correctly dispatch multiple events a single time', () => {
-        var evee = new Evee();
+        const evee = makeInstance();
         var resa = false;
         var resb = false;
         evee.on('a', _ => resa = true);
@@ -183,28 +187,28 @@ function run_tests(Evee, name) {
         assert.equal(true, resb);
       });
       it('should correctly dispatch the same event multiple multiple', () => {
-        var evee = new Evee();
+        const evee = makeInstance();
         var res = false;
         evee.on('a', _ => res = !res);
         evee.signal('a', 'a', 'a');
         assert.equal(true, res);
       });
       it('should throw when called without arguments', () => {
-        var evee = new Evee();
+        const evee = makeInstance();
         assert.throws(() => evee.signal());
       });
     });
     describe('#clear()', () => {
       it('should clear the receiver list', () => {
-        var evee = new Evee();
+        const evee = makeInstance();
         var res = false;
         evee.on('a', _ => res = true);
         evee.clear();
         evee.signal('a');
         assert.equal(false, res);
       });
       it('should not throw when no subscriptions are active', () => {
-        var evee = new Evee();
+        const evee = makeInstance();
         assert.doesNotThrow(() => evee.clear());
       });
     });