Micro Observables

Tiny simple observables heavily based on [riot.js] 1 observables and jQuery/Zepto events, but without any dependencies.

Installation

Just copy the microObservables.js file into your project directory.

Usage

When working in Node.JS, you must call the following to use it in your project.

var observable = require("./microObservable.js");

For a HTML project, you can include it as follows:

<script src="./microObservables.js"></script>

Now you are ready to begin, you can call observable passing any POJO that you want to be able to observe.

function MyObject () {
	observable(this);
};

Then add handlers to an instance of you POJO.

var x = new MyObject();
x.on("yourEventName", function () {
	// Do something
});

and trigger an event to call your handler

x.trigger("yourEventName");

You can also pass arguments to your handlers using triggers

x.on("anotherEventName", function (x) {
	// Do something
});

x.trigger("anotherEventName", 1);

You can remove handlers by event name. for example the code below will remove all the handlers for "yourEventName"

x.off("yourEventName");

And finally all the functions are composable, so you can do things like this

x.on("event1", function () {
	// do something
}).on("event2", function () {
	// do something
});

Running the tests

This requires that you have both [npm] 2 and [grunt-cli] 3 installed.

1. Download the latest code

2. Run npm install

3. run grunt test