node-pluggable

node-pluggable

Add your Hook more easily.

Demo

• lyssa

Installation

npm install node-pluggable

API

Pluggable = require 'node-pluggable'
pluggable = new Pluggable()

use([match_param ,] hook_callback...) => this

pluggable.use('article.create', (article, next) ->
  article.hook = 'article.create'
  next()
)

• this method is similar to connect
• match_param must be string or regex
• hook_callback will be called when param is matched

run(param, hook_callback_params...[, callback]) => this

article =
  title: 'title'
  author: 'author'
  content: 'content'

pluggable.run 'article.create', article, ->
  console.log article

• param will match with match_param, which must be string
• hook_callback_params will be send to hook_callback

del([match_param ,] hook_callback...) => this

pluggable.del('article.create', (article, next) ->
  article.hook = 'article.create'
  next()
)

• reverse of use

bind(hook_name, hook_callback...) => this

pluggable.bind 'article.update', (article) ->
  console.log article
, (article) ->
  console.log article.length

• hook_callback will be called when event be emitted

on(hook_name, hook_callback) => this

pluggable.on 'article.update', (article) ->
  console.log article

• similar to bind

emit(hook_name, data) => this

pluggable.emit 'article.update', 'just a message.'

• emit an event

License

MIT