comb

Comb

Overview

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

• OO utilties
• Collections
• Logging
• String & date formatting
• Proxy
• 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!

• Full api documentation with examples!

• 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
  • executeInOrder
    • Allows you to program asynchronous functions synchronously.

• Proxy helpers

  • methodMissing - handle those pesky 'has no method exception's
  • functionWrapper - wrap an object so you can use it as a function
  • handlerProxy - create a proxy for an object

• 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.0.9 /2012-02-16

• Complete redesign of comb.define to be more flexible and efficient
  • this._super does not require and Arguments object any more to call super
  • added "use strict" to all tests
  • New Features
    • comb.serial method for executing methods that return promises serially
    • comb.wrap method for wrapping node methods that require a function callback, with a promise
    • new date helper methods
      • comb.yearsFromNow
      • comb.yearsAgo
      • comb.daysFromNow
      • comb.daysAgo
      • comb.monthsFromNow
      • comb.monthsAgo
      • comb.hoursFromNow
      • comb.hoursAgo
      • comb.minutesFromNow
      • comb.minutesAgo
      • comb.secondsFromNow
      • comb.secondsAgo
    • comb.hitchIgnore/bindIngore for binding a method to a certain scope but ignoring all passed in parameters
    • comb.number.roundCeil for round numbers up always
  • Bug Fixes
    • Fixed logging appender level setting, before the appenders level would always be overriden on initialization