ticketman-client

the client(worker) part of https://github.com/yi/node-ticket-manager


Keywords
queue, ticket, job, pull
License
MIT
Install
npm install ticketman-client@0.1.0

Documentation

node-ticket-manager-client

the client(worker) part of https://github.com/yi/node-ticket-manager

NodeJS Module Usage

var  TicketWorker = require("ticketman").TicketWorker;
var  TicketManager = require("ticketman").TicketManager;

TicketManager API

new TicketManager : (@name, @host, basicAuth) ->

TicketManager.issue()
// issue : (title, category, content, callback)->

TicketWorker API

Instance construction

  constructor: (options={}) ->
  # @param {Object} options, optionally includes:
  #     options.name
  #     options.id
  #     options.consumerSecret
  #     options.host
  #     options.category
  #     options.timeout : ticket processing timeout in ms
  #     options.interval : self checking interval
  #     options.basicAuth : basicAuth
  #

Evnets:

  • on "new ticket", listener signature: eventListener(ticket)
  • on "complete", listener signature: eventListener(ticket)
  • on "giveup", listener signature: eventListener(ticket)

Instance Methods

  • complete : ()->
  • update : (message, kind='default')->
  • giveup: (reason)->