Mono Events Extension Module

This ia an extension module the Mono web framework. The Event module is used by other Mono modules (like the layout module) to add the Mono event support in their configurations.

Requirements and Dependencies

This module is built only on top of the Mono client library (M.js) and has no further dependencies.

Usage

Module that need Mono event support in their configurations need to:

1. add this module as a dependency in their mono.json descriptor (example):

{
    …
    "dependencies": [
        …
        "github/jillix/events/v0.1.1",
        …
    ],
    …
}

2. require this module in their client scripts (example):

var Events = require('github/jillix/events');

3. somewhere in the code (most often seen in the initialization function) call the Events function in the scope of this module, passing it the configuration (example):

var Events = require('github/jillix/events');

Added Configuration

This module extends a module's configuration with the listen key.

{
    "listen": {
        "miid1": {
            "event1FromMiid1": [ … ],
            "event2FromMiid1": [ … ]
        },
        "miid2": {
            "eventFromMiid2": [ … ]
        }
    }
}

where:

• listen: is an object that has as keys the miid's of the module to listen to and values event objects
• event object: is an objectt that has as keys the event names emitted by a module and as values action arrays
• action array: is an array of action objects to take (in order) when the particular event is received
• acction object: has as key one of: handler, event
  • handler actions can have as value either a string (a function name to be called) or an object if fixed parameters need to be passed to the handler function (see example below)
  • emit actions have as value a string (an event to be emitted)

{
    "listen": {
        "miid": {
            "eventFromMiid": [
                { "handler": "aFunctionInMiid1" },
                { "handler": { "name": "anotherFunctionInMiid1", "args": ["fixed argument"] } },
                { "emit": "anotherEvent" }
            ]
        }
    }
}

Changelog

v0.4.0

• transferred module to the new jxMono organization
• updated Utils to v0.2.0

v0.3.1

• Updated to [email protected]

v0.3.0

• Updated to [email protected]

v0.1.11

• Updated Utils to v0.1.2

v0.1.10

• Added Utils as dependency

v0.1.9

• The module can not uninit events (remove handlers) if an extra true argument is passed to the library: Events.call(self, self.config, true). The module configuration will be changed to store the function handlers.

v0.1.8

• Add event even the function is not found when the event is added. The function can be declared latter.

v0.1.7

• Fixed broken hasOwnProperty that used return instead of continue

v0.1.6

• Fixed counter declaration in for loops: replaced i with ii

v0.1.5

• added if (!obj.hasOwnProperty(key)) return; to object for loops

v0.1.4

• fixed IE8 compatibility by removing all for (var i in ...) expressions
• fixed simple event version to support global namespaced functions:

{
   "listen": {
       "myMiid": {
           "myEvent": "simple_handler_call"
       }
   }
}

v0.1.3

• added namespaced function support for handlers

v0.1.2

TODO

v0.1.0

TODO