multivents

multivents is a small yet flexible, multifunctional pub-sub library. It allows you to create event channels, send (asynchronous) events over those channels and subscribe to events.

Quick Start

If you want to get started quickly, here is a basic example of how to use multivents:

var Channel = require('multivents');
 
var myChannel = new Channel();
 
myChannel.on('greet', function (who) {
    console.log('hello ' + who);
});
 
myChannel.emit('greet', 'world'); // 'hello world'

If that's all you wanted to know, great! If not, you may read on to find out more.

Navigation

1. Features
2. Installation
3. Examples
4. Concepts
5. Contributing
6. Acknowledgments
7. License

Features

• Synchronous & asynchronous callback execution
• No Dependencies
• Thoroughly tested
• Multifunctional™

Installation

As multivents has no dependencies you can simply grab the latest release and include it in your project. multivents uses UMD, meaning it supports both CommonJS-style environments as well as AMD.

You can also install it via npm:

npm install multivents

If you want to extend multivents to your needs, you might want to run tests. In order to do this, you can clone this repository and run npm install and npm test. Tests are written with assert and run with mocha.

Examples

Check out the examples and API docs.

Concepts

Multivents aims to be a highly flexible, multifunctional library that can be used in projects of all sizes. It tries to be as small and fast as possible while offering you all the semantics for event systems that you could wish for. multivents mainly wants to get out of your way and attempts that by providing a straightforward API that includes a lot of optional parameters. The goal is for you to use multivents the way you want to, and not to be limited by the library's opinions.

Terminology

This README and all the documentation use a couple of terms synonymously: "event" and "message" are the same as well as event "name" and event "type". "Listening for an event", "adding a callback" and "subscribing to an event" all refer to the process of registering a function to be executed when an event is "emitted" / "triggered" / "fired".

Contributing

Contributions are welcome! Whether you want suggest or implement changes, check out the issues first and have a look at my more detailed notes on contributing.

Acknowledgments

This library started out as a fork of Fabien O'Carroll's minivents.

License

MIT License (MIT) © 2014-2018 Peter Steinberg