antenna - npm Package Compare versions

Comparing version 0.0.1 to 0.1.0

lib/index.js

 /**
  * Module dependencies.
  */
-var proto = require('./listener')
+var proto = require('./application')
   , utils = require('./utils');
@@ -6,0 +6,0 @@

lib/route.js

@@ -22,2 +22,10 @@ /**
 
+/**
+ * Check if this route matches `topic`, if so populate `params`.
+ *
+ * @param {String} topic
+ * @param {Array} params
+ * @return {Boolean}
+ * @api protected
+ */
 Route.prototype.match = function(topic, params) {
@@ -24,0 +32,0 @@ params = params || [];

lib/router.js

@@ -25,2 +25,10 @@ /**
 
+/**
+ * Route `topic` to one or more callbacks.
+ *
+ * @param {String} path
+ * @param {Function|Array} fns
+ * @return {Router}
+ * @api protected
+ */
 Router.prototype.route = function(topic, fns) {
@@ -52,2 +60,9 @@ var fns = utils.flatten([].slice.call(arguments, 1));
 
+/**
+ * Route dispatcher, aka the router "middleware".
+ *
+ * @param {Message} msg
+ * @param {Function} next
+ * @api private
+ */
 Router.prototype._dispatch = function(msg, next) {
@@ -80,3 +95,4 @@ debug('dispatching %s (%s)', msg.topic, msg.originalTopic);
         } else if (fn) {
-          fn(msg, callbacks);
+          if (fn.length < 3) { return fn(msg, callbacks); }
+          callbacks();
         } else {
@@ -93,2 +109,12 @@ nextRoute(err);
 
+/**
+ * Attempt to match a route for `msg`
+ * with optional starting index of `i`
+ * defaulting to 0.
+ *
+ * @param {Message} msg
+ * @param {Number} i
+ * @return {Route}
+ * @api private
+ */
 Router.prototype._match = function(msg, i) {
@@ -95,0 +121,0 @@ var topic = msg.topic

package.json

 {
   "name": "antenna",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Ubiquitous message bus for Node.js.",
   "keywords": [
+    "bus",
     "pubsub"
@@ -28,2 +29,7 @@ ],
   "dependencies": {
+    "configurable": "0.0.x",
+    "urlpattern": "0.1.x",
+    "utils-merge": "1.x.x",
+    "utils-flatten": "1.x.x",
+    "debug": "0.7.x"
   },
@@ -30,0 +36,0 @@ "devDependencies": {

README.md

 # antenna
+
+[![Build](https://travis-ci.org/jaredhanson/antenna.png)](https://travis-ci.org/jaredhanson/antenna)
+[![Coverage](https://coveralls.io/repos/jaredhanson/antenna/badge.png)](https://coveralls.io/r/jaredhanson/antenna)
+[![Quality](https://codeclimate.com/github/jaredhanson/antenna.png)](https://codeclimate.com/github/jaredhanson/antenna)
+[![Dependencies](https://david-dm.org/jaredhanson/antenna.png)](https://david-dm.org/jaredhanson/antenna)
+[![Tips](http://img.shields.io/gittip/jaredhanson.png)](https://www.gittip.com/jaredhanson/)
+
+
+Antenna is a [publish/subscribe](http://en.wikipedia.org/wiki/Publish/subscribe)
+middleware layer for [Node](http://nodejs.org).  Applications can be constructed
+by using _middleware_ and defining _routes_.
+
+This architecture has been proven effective by [Express](http://expressjs.com/),
+which provides HTTP middleware.  Antenna adopts this approach, repurposing it
+for use with a message bus, allowing listeners to be built quickly and easily,
+using patterns familiar to Node.js developers.
+
+## Install
+
+    $ npm install antenna
+    
+## Usage
+
+    var antenna = require('antenna');
+    var app = antenna();
+    
+    app.listen('events/:event', function(msg, next) {
+      console.log('got event: ' + msg.params.event);
+    });
+
+## Adapters
+
+Adapters are used to connect to message buses, receiving messages and
+dispatching those messages to the application for processing.
+
+The following table lists commonly used adapters:
+
+|Adapter                                             |Developer                                       |
+|----------------------------------------------------|------------------------------------------------|
+|[AMQP](https://github.com/jaredhanson/antenna-amqp) |[Jared Hanson](https://github.com/jaredhanson)  |
+
+## Tests
+
+    $ npm install
+    $ make test
+
+## Credits
+
+  - [Jared Hanson](http://github.com/jaredhanson)
+
+## License
+
+[The MIT License](http://opensource.org/licenses/MIT)
+
+Copyright (c) 2014 Jared Hanson <[http://jaredhanson.net/](http://jaredhanson.net/)>

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

11588

increased by38.93%

Lines of code

321

increased by24.42%

Number of lines in readme file

57

increased by2750%

Worsened metrics

Dependency count

5

increased byInfinity%

Dependency changes

• + Addedconfigurable@0.0.x

• + Addeddebug@0.7.x

• + Addedurlpattern@0.1.x

• + Addedutils-flatten@1.x.x

• + Addedutils-merge@1.x.x

• + Addedconfigurable@0.0.1(transitive)

• + Addeddebug@0.7.4(transitive)

• + Addedurlpattern@0.1.0(transitive)

• + Addedutils-flatten@1.0.0(transitive)

• + Addedutils-merge@1.0.1(transitive)