comb

#Comb

###NOTE: v0.1.1 removed proxy code out of core see comb-proxy

##Overview

Framework for node that provides a one stop shop for frequently needed utilities, including:

• OO utilties
• Collections
• Logging
• String & date formatting
• Flow control
• Date Management

See Usage for more details.

Installation

npm install comb

##Why?

If your like us its fun to find new modules to use but often wish you didn't have to sift through NPM registry or the node modules page to find what you need.

So....

We created a library of things we use often, or commons utilities that are used by our other APIs.

##Highlights

• > 99% test coverage! And we're always adding more!

• comb(define|singleton)

  • The back bone of comb.
  • Options for classical inheritance models as well as mixins(pseudo multi-inheritance)
  • You can call this._super from any method. Including statically defined ones!
  • Access to you class level properties within an instance
  • And much more...

• Logging

  • Powerful logging API!
  • Logger inheritance through name spaces
  • Predefined level definition along with the ability to define your own.
  • Multiple appenders including
    • FileAppender - log it to a file
    • RollingFileAppender - log it to a file up to a customizable size then create a new one!
    • JSONAppender - write it out as JSON to a file.
    • ConsoleAppender - log it to the console
  • All appenders can be using with custom levels, separately, or all together.
  • Configurable with files OR programatically

• Collections

  • RedBlackTree, AVLTree, AnderssonTree, BinaryTree, HashTable, MaxHeap, MinHeap, Pool, PriorityQueue, Queue, Stack

• Flow control

  • Promises
  • PromiseLists

• Tell me more!

##Usage

• OO system
  • define
  • singleton
• Collections
  • RedBlackTree
  • AVLTree
  • AnderssonTree
  • BinaryTree
  • HashTable
  • MaxHeap
  • MinHeap
  • Pool
  • PriorityQueue
  • Queue
  • Stack
• Logging
  • Logger
  • Level
  • Appenders
    • Appender
    • ConsoleAppender
    • FileAppender
    • JSONAppender
    • RollingFileAppender
  • Configurators
    • BasicConfigurator
    • PropertyConfigurator
• Plugins for objects defined with comb
  • Broadcaster
  • Middleware
• Promises
• PromiseLists
• Utilities
  • comb
  • Array
  • Date
  • Number
  • Regexp
  • String
  • Characters

##License

MIT https://github.com/Pollenware/comb/raw/master/LICENSE

##Meta

• Code: git clone git://github.com/Pollenware/comb.git
• JsDoc: http://pollenware.github.com/comb
• Website: http://pollenware.com - Twitter: http://twitter.com/pollenware - 877.465.4045

Changelog

0.1.4/2012-08-20

• added new short cut for configuring loggers
• Added changed logger.addAppender to accept a string and options to use Appender.createAppender method.
• comb.argsToArray now takes a slice argument to remove arguments.
• Added a resolve function to comb.Promise to handle node style callback resolution.
• Added a "promise" method to comb.Promise to allow for the return of an object that will not allow calling function to resolve the promise.
• Cleaned up promise using code to return the "promise" wrapper.