hook-ware

A hook system using ware for the browser and server.

Hook-ware is gracefully handles generators when you're in an environment that supports them.

Example

var hooks = Hooks();

// add the hooks
hooks.use('resolve', fn);
hooks.use('resolve', fn);
hooks.use('fetch', fn);

// run the "fetch" hook
hooks.run('fetch', 'a', 'b', done);

Or with generators:

var hooks = Hooks();

// add the hooks
hooks.use('resolve', fn);
hooks.use('resolve', fn);
hooks.use('fetch', fn);

// run the "fetch" hook
yield hooks.run('fetch', 'a', 'b');

Installation

Node:

$ npm install hook-ware

Browser (with Duo):

var hooks = require('matthewmueller/hook-ware');

API

Hooks()

Initialize hook-ware.

Hooks.use(name, fn)

Add a hook to the plugin name. The fn can be a synchronous, asynchronous, generator function, or anything else that ware supports.

Hooks.method(name)

Add a method name to add hooks more fluently. You can add methods statically that get applied to all hooks instances or on each instance.

var hooks = Hooks()
  .method('install')
  .method('build');

hooks.install(fn);
hooks.build(fn);

hooks.run('install', done);

Or statically:

Hooks.method('fetch')

var hooks = Hooks()
  .method('build');

hooks.fetch(fn);
hooks.build(fn);

hooks.run('fetch', done)

Hooks.run(name, args..., [fn])

Run the hooks for name, passing a number of args in. Optionally pass a callback function. If no callback function is specified, hook-ware will return a thunk that can be yielded.

Test

npm install
make test

License

(The MIT License)

Copyright (c) 2014 Matthew Mueller <[e-mail]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.