eventhub.js

Event Hub(bus) implemented in JavaScript

---

Table of Contents

1. Installation
2. Files available
   1. Non-compiled
   2. Compiled
   3. TypeScript declaration file
3. Usage
   1. Initialization
   2. Attach event
   3. Detach event
   4. Fire event
   5. Example
4. Contributing
5. License

---

1. Installation

Install the version you want by navigating to the relase tab and choosing the one you want

or

Install the latest version

npm install norzon/eventhub.js

---

2. Files available

2.1 Non-compiled

If you plan on compiling to an earlier version of JS, such as ES5, or you don't care about compatibility then use:

node_modules/eventhub.js/lib/eventhub.js

2.2 Compiled

On the other hand, if you care about compatibility and are not planning on compiling to ES5 or similar, use:

node_modules/eventhub.js/dist/eventhub.js
(or)
node_modules/eventhub.js/dist/eventhub.min.js

2.3 TypeScript declaration file

For TypeScript users, the declaration file can be found at:

node_modules/eventhub.js/lib/eventhub.d.ts

---

3. Usage

The eventhub.js library declares an "EventHub" class, therefore you can have many eventhub instances where each one has seperate event listeners and handlers.

3.1 Initialization

To initialize an EventHub object, use:

const eventhub = new EventHub();

3.2 Attach event

To attach an event listener use:

eventhub.on('my-event', myCallbackFunction);
// or
eventhub.$on('my-event', myCallbackFunction);
// or
eventhub.listen('my-event', myCallbackFunction);

3.3 Detach event

To detach an event listener that was attached, use:

eventhub.off('my-event', myCallbackFunction);
// or
eventhub.$off('my-event', myCallbackFunction);
// or
eventhub.remove('my-event', myCallbackFunction);

3.4 Fire event

To emit, fire, an event use:

eventhub.emit('my-event', myCallbackFunction);
// or
eventhub.$emit('my-event', myCallbackFunction);
// or
eventhub.fire('my-event', myCallbackFunction);

3.5 Example

// Initialize new object
const eventhub = new EventHub();

// For convenience set a variable to the event name
let key = 'window.loaded';

// Attach the event
eventhub.on(key, function(msg){
    if (typeof msg !== 'string' || msg.length === 0) {
        msg = 'Invalid message passed'
    }
    if (typeof alert === "function") {
        // We are probably in the browser
        alert(msg);
    } else {
        // We are probably in node
        console.log(msg);
    }
});

// Fire the event
eventhub.emit(
    key,
    'After this, the event is detached. That means goodbye!'
);

// Detach the event
eventhub.off(key);

// Try to fire again, but fail
eventhub.emit(key, 'This message will not be displayed');

After this, you are hopefully ready to start coding!

---

4. Contributing

Any contributions are welcome!

Contribute by

• Creating a pull request
• Creating an issue

Commit & Push flow

Clone the repo

git clone https://github.com/norzon/eventhub.js.git

Make changes to files

Open with your favorite text editor and code away! Use below command to build and test code (generated code in ./dev)

npm run dev

Build the project

Build the project using:

npm run build

Create/adjust testing

Depending on what you coded, create or adjust the file "test/test.js". This file contains code to test this library using the "Mocha" library. Check Mocha's documentation here

Run test

Run Mocha test using:

npm run test

Commit & Push

All set to commit. Explain the changes in the commit message and push to the repo!

---

5. License

eventhub.js is available under the GNU General Public License version 3