wodge

#wodge A collection of useful functions.

#API Documentation Generated jsdoc documentation.

##extend Merge a list of objects, left to right, into one.

###Parameters object {Object} - a sequence of Object instances to be extended

###Example

> w.extend({}, { one: 1, three: 3 }, { one: "one", two: 2 }, { four: 4 });
{ one: 'one',
  three: 3,
  two: 2,
  four: 4 }

##clone Clones an object or array

###Parameters input {Object,Array} - the input to clone

###Example

> date = new Date()
Fri May 09 2014 13:54:34 GMT+0200 (CEST)
> w.clone(date)
{}  // a Date instance doensn't own any properties
> date.clive = "hater"
'hater'
> w.clone(date)
{ clive: 'hater' }
> array = [1,2,3]
[ 1, 2, 3 ]
> newArray = w.clone(array)
[ 1, 2, 3 ]
> array === newArray
false

Returns Object,Array

##omit Returns a clone of the input object, minus the specified properties

###Parameters object {Object} - the object to clone
toOmit {string[]} - an array of property names to omit from the clone

###Example

> w.omit({ one: 1, two: 2, three: 3, four: 4 }, [ "two", "four" ]);
{ one: 1, three: 3 }

Returns Object

##escapeRegExp escape special regular expression characters

###Example

> w.escapeRegExp("(.*)");
'\\(\\.\\*\\)'

##pluck Plucks the value of the specified property from each object in the input array

###Parameters arrayOfObjects {Object[]} - the input array of objects
the {string} - property to pluck

###Example

> var data = [
...     {one: 1, two: 2},
...     {two: "two"},
...     {one: "one", two: "zwei"},
... ];
undefined
> w.pluck(data, "one");
[ 1, 'one' ]
> w.pluck(data, "two");
[ 2, 'two', 'zwei' ]
> w.pluck(data, "one", "two");
[ 1, 'two', 'one' ]

Returns Array

##isNumber Returns true if input is a number

###Example

> w.isNumber(0)
true
> w.isNumber(1)
true
> w.isNumber(1.1)
true
> w.isNumber(0xff)
true
> w.isNumber(0644)
true
> w.isNumber(6.2e5)
true
> w.isNumber(a)
false
> w.isNumber(NaN)
false
> w.isNumber(Infinity)
false

##isPlainObject Returns true if input type is object and not an Array

###Parameters input {*} - the input to test

###Example

> w.isPlainObject(new Date())
true
> w.isPlainObject({ clive: "hater" })
true
> w.isPlainObject([ 0, 1 ])
false

Returns boolean

##arrayify Takes input and guarantees an array back. Result can be one of three things:

• puts a single scalar in an array
• converts array-like object (e.g. arguments) to a real array
• converts null or undefined to an empty array

###Parameters input {*} - the input value to convert to an array

###Example

> w.arrayify(null)
[]
> w.arrayify(0)
[ 0 ]
> w.arrayify([ 1, 2 ])
[ 1, 2 ]
> function f(){ return w.arrayify(arguments); }
undefined
> f(1,2,3)
[ 1, 2, 3 ]

Returns Array

##every Returns true if the supplied iterator function returns true for every property in the object

###Parameters object {Object} - the object to inspect
iterator {function} - the iterator function to run against each key/value pair, the args are (value, key).

###Example

> function aboveTen(input){ return input > 10; }
undefined
> w.every({ eggs: 12, carrots: 30, peas: 100 }, aboveTen)
true
> w.every({ eggs: 6, carrots: 30, peas: 100 }, aboveTen)
false

Returns Boolean

##each Runs the iterator function against every key/value pair in the input object

###Parameters object {Object} - the object to iterate
callback {function} - the iterator function to run against each key/value pair, the args are (value, key).

###Example

> var total = 0;
undefined
> function addToTotal(n){ total += n; }
undefined
> w.each({ eggs: 3, celery: 2, carrots: 1 }, addToTotal)
undefined
> total
6

##bytesToSize Convert bytes to human-readable size

###Parameters bytes {number} - the bytes value to convert
precision {number} - number of decimal places optional default=0

###Example

> w.bytesToSize(10000)
'10 KB'
> w.bytesToSize(10000, 1)
'9.8 KB'
> w.bytesToSize(10000, 2)
'9.77 KB'
> w.bytesToSize(10000, 3)
'9.766 KB'

Returns string

##getHomeDir Cross-platform home directory retriever

###Example

> w.getHomeDir()
'/Users/Lloyd'

##fill Create a new string filled with the supplied character

###Parameters fillWith {string} - the fill character
len {number} - the length of the output string

###Example

> w.fill("a", 10)
'aaaaaaaaaa'
> w.fill("ab", 10)
'aaaaaaaaaa'

Returns string

##padRight Add padding to the right of a string

###Parameters input {string} - the string to pad
width {number} - the desired final width
padWith {string} - the padding character optional default=" "

###Example

> w.padRight("clive", 1)
'clive'
> w.padRight("clive", 1, "-")
'clive'
> w.padRight("clive", 10, "-")
'clive-----'

Returns string

##exists returns true if a value, or nested object value exists in an array

###Parameters array {Array} - the array to search
value {*} - the value to search for

###Example

> w.exists([ 1, 2, 3 ], 2)
true
> w.exists([ { result: false }, { result: false } ], { result: true })
false
> w.exists([ { result: true }, { result: false } ], { result: true })
true
> w.exists([ { result: true }, { result: true } ], { result: true })
true

Returns boolean

##without Returns the input array, minus the specied values

###Parameters array {Array} - the input array
toRemove {*} - a single, or array of values to omit

###Example

> w.without([ 1, 2, 3 ], 2)
[ 1, 3 ]
> w.without([ 1, 2, 3 ], [ 2, 3 ])
[ 1 ]

Returns Array

##first Returns the first object in the input array with property set to value.

###Parameters objectArray {Object[]} - input array of objects
prop {string} - property to inspect
val {*} - desired value

###Example

> w.first([{ product: "egg", stock: true }, { product: "chicken", stock: true }], "stock", true)
{ product: 'egg', stock: true }
> w.first([{ product: "egg", stock: true }, { product: "chicken", stock: true }], "stock", false)
undefined

Returns Object,undefined

##commonDir commonDir returns the directory common to each path in the list

###Parameters files {Array} - An array of file paths to inspect

###Example

> files = fs.readdirSync(".").map(function(file){ return path.resolve(file); })
[ '/Users/Lloyd/Documents/75lb/wodge/.DS_Store',
  '/Users/Lloyd/Documents/75lb/wodge/.git',
  '/Users/Lloyd/Documents/75lb/wodge/.gitignore',
  '/Users/Lloyd/Documents/75lb/wodge/.jshintrc',
  '/Users/Lloyd/Documents/75lb/wodge/README.md',
  '/Users/Lloyd/Documents/75lb/wodge/lib',
  '/Users/Lloyd/Documents/75lb/wodge/node_modules',
  '/Users/Lloyd/Documents/75lb/wodge/package.json',
  '/Users/Lloyd/Documents/75lb/wodge/test' ]
> w.commonDir(files)
'/Users/Lloyd/Documents/75lb/wodge/'

Returns string - A single path ending with the path separator, e.g. "/user/some/folder/"

##union merge two arrays into a single array of unique values

###Example

> var array1 = [ 1, 2 ], array2 = [ 2, 3 ];
undefined
> w.union(array1, array2)
[ 1, 2, 3 ]
> var array1 = [ { id: 1 }, { id: 2 } ], array2 = [ { id: 2 }, { id: 3 } ];
undefined
> w.union(array1, array2)
[ { id: 1 }, { id: 2 }, { id: 3 } ]
> var array2 = [ { id: 2, blah: true }, { id: 3 } ]
undefined
> w.union(array1, array2)
[ { id: 1 },
  { id: 2 },
  { id: 2, blah: true },
  { id: 3 } ]
> w.union(array1, array2, "id")
[ { id: 1 }, { id: 2 }, { id: 3 } ]

##commonSequence Returns the initial elements which both input arrays have in common

###Parameters a {Array} -
b {Array} -

###Example

> w.commonSequence([1,2,3], [1,2,4])
[ 1, 2 ]

Returns Array

##escapeForJSON strips special characters, making suitable for storage in a JS/JSON string

###Parameters input {string} - the input

Returns string