dysf.utils

Custom dysfunctional utilities for node.js

npm install dysf.utils
1 downloads in the last day
28 downloads in the last week
79 downloads in the last month

Table of Contents generated with DocToc

dysf.utils Build Status

Custom dysfunctional utilities for node.js !!!

Usage

  • utils - utils = require("dysf.utils").utils;
  • logger - logger = require("dysf.utils").logger;
  • mock - mock = require("dysf.utils").mock;

API

logger

A key reason for creating my own logger was to print file path and line numbers from where a log message was called. Additionally it prints the date/time and also has a few additional levels of logging.

  • logger.setLogLevel( id )
    • 0: system, 1: error, 2: warn, 3: event, 4: info, 5: debug, 6: trace. Default is 4 (info)
  • logger.system ( msg | obj )
    • Useful for system level notifications.
  • logger.error ( msg | obj )
  • logger.warn ( msg | obj )
  • logger.event ( msg | obj )
    • Recommended for key events like new tranactions / sessions / requests etc.
  • logger.info ( msg | obj )
    • Recommended for notable phases within a transaction like handlers, methods etc.
  • logger.debug ( msg | obj )
    • Recommended for useful property values or callback tracking.
  • logger.trace ( msg | obj )
    • Recommended for detailed debugging like printing object contents.

utils

A random utility collection of one. Render a file to the Response in cases where you are not using a micro or mega framework.

  • utils.renderFile ( response, path, replaceParams, callback )
    • response: Http Response
    • path: path to file
    • replaceParams: A hash of Ket Value pairs with the key representing the string to replace with the Value.
    • callback: to help with callback hell.

mock

The start of a few mock objects primarily useful in quick and dirty unit testing.

  • mock.response ( text )

Installation

Global

  • Run: sudo npm install dysf.utils -g
  • Usually installed at - /usr/local/lib/node_modules/dysf.utils

Project

  • Add "dysf.utils": "x.x.x" to the dependencies section of your project's package.json
    • Example "dependencies": { "dysf.utils": "x.x.x" }
  • Run npm install in the director with your package.json
  • Usually installed at - PROJECT_DIR/node_modules/dysf.utils
npm loves you