Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/allouis/minivents

✨JavaScript events in 355 Bytes✨
https://github.com/allouis/minivents

Last synced: about 1 month ago
JSON representation

✨JavaScript events in 355 Bytes✨

Lists

README

        

# minivents [![Build Status](https://travis-ci.org/allouis/minivents.svg?branch=master)](https://travis-ci.org/allouis/minivents)

http://allouis.github.io/minivents/

# API

`on` : Listen to event. Params { type:`String`, callback:`Function` | context:`Object` }. Returns `target`.

`off` : Stop listening to event. Params { type:`String` | callback:`Function` }. Returns `target`.

`emit`: Emit event. Params { type:`String` | data:`Object` }. Returns `target`.

# Constructor Example
```javascript
var sandbox = new Events();

sandbox.on("event", function(){
// do stuff
});

sandbox.emit("event"); //does stuff

sandbox.off("event");

sandbox.emit("event"); //does not do stuff
```
# Mixin Example
```javascript
var sandbox = {
otherStuff: true
};

Events(sandbox);

sandbox.on("event", function(){
// do stuff
});

sandbox.emit("event"); //does stuff

sandbox.off("event");

sandbox.emit("event"); //does not do stuff
```