Foolproof.js

Status: Deprecated

Please use lodash-node instead.

Please refer to the test file. To run it, simply get expect.js and mocha, and run mocha, like this:

$ cd ~/YourProject/
$ npm install expect.js
$ npm install -g mocha
$ mocha

Description

Foolproof.js is a group of helper functions intended to extend the native language features for node applications, simplify type checking, and allow for graceful handling of unexpected conditions.

Functions:

systemLogger

Has use() and epicFail() methods, allows setting of a custom error handler.

<dt>E(typeof var)</dt>
<dd>A shorthand for (typeof var !== 'undefined')</dd>

<dt>U(typeof var)</dt>
<dd>A shorthand for (typeof var === 'undefined')</dd>

<dt>failWhen(condition, message, level, errorType)</dt>
<dd>A fail-fast method, invokes SystemLogger.EpicFail() when condition is true.</dd>

<dt>ƒ(typeof var)</dt>
<dd>A fail-fast method, always use with typeof.</dd>

<dt>findProperty(obj, 'parent.child.property')</dt>
<dd>Access any properties/sub-properties of obj using dot notation (false if no match).</dd>

<dt>removeItem(needle, haystack)</dt>
<dd>Modifies haystack, removing the item which strictly matches needle.</dd>

<dt>concatUnique(existing, additional)</dt>
<dd>Adds only unique items from additional to existing.</dd>

<dt>inArray(needle, haystack)</dt>
<dd>True if haystack strictly contains needle.</dd>

<dt>objExtend(to, from)</dt>
<dd>Reimplementation of jQuery extend method, minus support for extending jQuery itself.</dd>

Complete list of methods:

var methods = {
       "U"                :  U
    ,  "E"                :  E
    ,  "dd"               :  dd
    ,  "systemLogger"     :  systemLogger
    ,  "failWhen"         :  failWhen
    ,  "inArray"          :  inArray
    ,  "concatUnique"     :  concatUnique
    ,  "findUnique"       :  findUnique
    ,  "removeItem"       :  removeItem
    ,  "nameOf"           :  nameOf
    ,  "typeOf"           :  typeOf
    ,  "isType"           :  isType
    ,  "isFunction"       :  isFunction
    ,  "isObject"         :  isObject
    ,  "isBoolean"        :  isBoolean
    ,  "isString"         :  isString
    ,  "isRegex"          :  isRegex
    ,  "isArray"          :  isArray
    ,  "isNull"           :  isNull
    ,  "isNumber"         :  isNumber
    ,  "isNumeric"        :  isNumeric
    ,  "isTruthy"         :  isTruthy
    ,  "isFalsey"         :  isFalsey
    ,  "isNot"            :  isNot
    ,  "notFunction"      :  notFunction
    ,  "notObject"        :  notObject
    ,  "notBoolean"       :  notBoolean
    ,  "notString"        :  notString
    ,  "notRegExp"        :  notRegExp
    ,  "notArray"         :  notArray
    ,  "notNull"          :  notNull
    ,  "notNumber"        :  notNumber
    ,  "standardizePath"  :  standardizePath
    ,  "isValidPath"      :  isValidPath
    ,  "notValidPath"     :  notValidPath
    ,  "urlParse"         :  urlParse
    ,  "isFolderSync"     :  isFolderSync
    ,  "isFileSync"       :  isFileSync
    ,  "filesHereSync"    :  filesHereSync
    ,  "formPath"         :  formPath
    ,  "fileName"         :  fileName
    ,  "fullPath"         :  fullPath
    ,  "parentFolder"     :  parentFolder
    ,  "loadFileSync"     :  loadFileSync
    ,  "loadFile"         :  loadFile
    ,  "findProperty"     :  findProperty
    ,  "objExtend"        :  objExtend
}

Available from npm

$ npm install foolproof

will add it to your node_modules folder.

How to Include Foolproof.js

Foolproof provides a function (extend) which allows you to decide how to add the helpers to your project.

require('foolproof').extend(root)
// Adds helpers to the node global object.
 
console.log( isString('this is a demo') )
// prints true
  
console.log( isFunction( function(){} ) )
// prints true

If you choose to use foolproof this way, the helpers become like truly native language features, in that they are immutable:

require('foolproof').extend(root)
 
console.log( isString )
// prints [Function: isString]
 
isString = null
console.log( isString )
// prints [Function: isString]

Or, if you would rather attach the helpers to a namespace object, simply pass that to extend(), like so:

var fp = {}
require('foolproof').extend(fp)
 
console.log( fp.isString('this is a demo') )
// prints true
  
console.log( fp.isFunction( function(){} ) )
// prints true