tousen v0.0.8

tousen

tousen (豆扇) is an async Sensu API client written in CoffeeScript, originally developed for use with Hubot

Full documentation of all API wrapper methods can be found on the appropriate classes here.

Presently, it is in the very early stages of development.

Installation

npm install tousen

Dependencies

• scoped-http-client
• async

Usage

Require the package and instantiate a client.

Tousen = require 'tousen'
sensu_api = new Tousen url: 'http://sensu.example.com:4567'

Then, make some API calls!

sensu_api.events.get_events callback: (err, res) ->
  if err
    console.log 'It looks like the Sensu API may not be working :('
  else
    console.log 'res is now an object containing all events!'

Full documentation may be found here.

Generating Documentation

Documentation may be generated using codo. To do so:

npm install
codo

Then, open doc/index.html in a browser to view it.

Acknowledgements

Credit goes to @foonix for the name of this project.