QuickEvent - A tiny javascript event engine

Creating your own events in javascript can seem a bit unruly, with magic strings and tenuous links between subscriber and publisher. QuickEvent is a tiny piece of javascript that allows you to create events in your code the way you think it should work.

Give me the code

Here you go:

Usage: Create Event

Creating a new event is as simple as instantiating a new variable.

var onTweet = new QuickEvent();

Once we’ve created our event and as with most pubsub event patterns there are two main components, Subscribing and Publishing.

Usage: Subscribe

To Subscribe to an event, you use the subscribe method as shown below:

onTweet.subscribe(function (tweet, user) {
    console.log(user + " totally just tweeted this: " + tweet);
});

Where did the parameters tweet and user come from? Ah, well the beauty of QuickEvent is that anything you pass in will be passed out as seen below in the Publish section.

Usage: Publish

Publishing an event triggers the data to be sent to all subscribers, hence why I’ve named the method “trigger” (I felt it better describes what is happening). You can trigger an event by using the following code:

onTweet.trigger(this, "I love the way this works", "@benjii22");

You might be asking, “Why are there three arguments when only two arrive at the subscriber?” Well the first argument allows you to set the “this” scope at the subscriber end. In this case I’ve set the “this” of the subscriber to be the “this” of this. Confused? I was too until I spent some time with this amazing javascript tutorial by John Resig. Seriously, spend some time reading and completing the tutorial (it’s interactive). It’s well worth it.

Anyway, the idea is that the first argument will set the context, and then you can add as many arguments as you like afterwards and they’ll all be passed to the subscribers. Different events can have different numbers of parameters, it’s up to you.