Make your application pluggable!
Getting Started
To install the module, run the following in the command line:
npm i dovetail --save
Use within your application with the following lines of JavaScript:
var events = ; // require the main Dovetail classvar Dovetail = ; // create an "application" to be pluggablevar { // make it an EventEmitter eventsEventEmitter; // create a new instance of Dovetail // passing in your application thisdovetail = this; // automatically load middleware thisdovetail;}; ;
Nothing else is required, but the middleware won't run until you trigger them
MyAppprototype { thisdovetail;};
Now you can drop a javascript file into your middleware folder and it'll be registered:
module { // create a middleware function that takes a params object and done callback function var { console; console; // add something to the params to be passed back to your app paramsstartTime = ; // let the app know that the middleware is finished // and the next middleware can run ; }; middlewareoptions = // name your middleware name: 'my-custom-middleware' // describe your middleware description: 'This is an awesome middleware that runs before the application starts.' // list of events your middleware will listen for events: 'app:before:start' ; // Return an object containing your middleware functions // These will get registered with the app var rtn = {}; rtnmiddlewareoptionsname = middleware; return rtn; };
Create a function for your app that will trigger some events:
MyAppprototype { var self = this; // set up some paramets to keep track of state selfparams = {}; // trigger that the app will be starting self;}
Contributing
Find a bug? Have a feature request? Please create an Issue.
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality,
and run docs
in the command line to build the docs with Verb.
Pull requests are also encouraged, and if you find this project useful please consider "starring" it to show your support! Thanks!
Author
Brian Woodward
License
Copyright (c) 2014 Brian Woodward, contributors. Released under the MIT license
This file was generated by verb-cli on May 01, 2014.