wodge - npm Package Compare versions

Comparing version 0.6.3 to 0.6.4

boil.json

 {
     "readme":{
-        "template": "[![view on npm](http:\/\/img.shields.io\/npm\/v\/wodge.svg)](https:\/\/www.npmjs.org\/package\/wodge)\n![npm module downloads per month](http:\/\/img.shields.io\/npm\/dm\/wodge.svg)\n[![Dependency Status](https:\/\/david-dm.org\/75lb\/wodge.svg)](https:\/\/david-dm.org\/75lb\/wodge)\n![Analytics](https:\/\/ga-beacon.appspot.com\/UA-27725889-25\/wodge\/README.md?pixel)\n\n[![browser support](https:\/\/ci.testling.com\/75lb\/wodge.png)](https:\/\/ci.testling.com\/75lb\/wodge)\n\n#wodge\nA collection of useful functions.\n\n#API Documentation\nGenerated jsdoc documentation.\n\n{{#if functions}}{{#each functions}}##{{{name}}}\n{{#if description}}{{{description}}}\n\n{{\/if~}}\n\n{{#if parameters}}###Parameters\n{{#each parameters}}{{name}} { {{~type~}} } - {{{description}}}{{#if optional}} *optional*{{\/if}}{{#if default}} *default={{{default}}}*{{\/if}}  \n{{\/each}}\n{{\/if~}}\n\n{{#if examples}}###Example\n{{#each examples}}```js\n{{{this}}}\n```\n{{\/each}}{{\/if~}}\n\n{{#if returns}}**Returns** {{returns.type}} {{{returns.description}}}\n\n{{\/if~}}\n\n\n{{\/each}}{{\/if}}",
+        "template": "[![view on npm](http:\/\/img.shields.io\/npm\/v\/wodge.svg)](https:\/\/www.npmjs.org\/package\/wodge)\n![npm module downloads per month](http:\/\/img.shields.io\/npm\/dm\/wodge.svg)\n[![Dependency Status](https:\/\/david-dm.org\/75lb\/wodge.svg)](https:\/\/david-dm.org\/75lb\/wodge)\n![Analytics](https:\/\/ga-beacon.appspot.com\/UA-27725889-25\/wodge\/README.md?pixel)\n\n[![browser support](https:\/\/ci.testling.com\/75lb\/wodge.png)](https:\/\/ci.testling.com\/75lb\/wodge)\n\n#wodge\nA collection of useful functions.\n\n#API Documentation\nGenerated jsdoc documentation.\n\n{{#if functions}}{{#each functions}}##{{{name}}}\n{{#if description}}{{{description}}}\n\n{{\/if~}}\n\n{{#if parameters}}###Parameters\n{{#each parameters}}{{name}} { {{~type~}} } - {{{description}}}{{#if optional}} *optional*{{\/if}}{{#if default}} *default={{{default}}}*{{\/if}}  \n{{\/each}}\n{{\/if~}}\n\n{{#if returns}}**Returns** {{returns.type}} {{{returns.description}}}\n\n{{#if examples}}###Example\n{{#each examples}}```js\n{{{this}}}\n```\n{{\/each}}{{\/if~}}\n\n{{\/if~}}\n\n\n{{\/each}}{{\/if}}",
         "data": {
@@ -5,0 +5,0 @@ "functions": [

package.json

 {
   "name": "wodge",
-  "version": "0.6.3",
+  "version": "0.6.4",
   "description": "a wodge of functional dough",
@@ -5,0 +5,0 @@ "main": "lib/wodge.js",

README.md

@@ -20,10 +20,2 @@ [![view on npm](http://img.shields.io/npm/v/wodge.svg)](https://www.npmjs.org/package/wodge)
 
-###Example
-```js
-> w.extend({}, { one: 1, three: 3 }, { one: "one", two: 2 }, { four: 4 });
-{ one: 'one',
-  three: 3,
-  two: 2,
-  four: 4 }
-```
 ##clone
@@ -35,2 +27,4 @@ Clones an object or array
 
+**Returns** Object,Array 
+
 ###Example
@@ -53,4 +47,2 @@ ```js
 ```
-**Returns** Object,Array 
-
 ##omit
@@ -63,2 +55,4 @@ Returns a clone of the input object, minus the specified properties
 
+**Returns** Object 
+
 ###Example
@@ -69,12 +63,5 @@ ```js
 ```
-**Returns** Object 
-
 ##escapeRegExp
 escape special regular expression characters
 
-###Example
-```js
-> w.escapeRegExp("(.*)");
-'\\(\\.\\*\\)'
-```
 ##pluck
@@ -87,2 +74,4 @@ Plucks the value of the specified property from each object in the input array
 
+**Returns** Array 
+
 ###Example
@@ -103,28 +92,5 @@ ```js
 ```
-**Returns** Array 
-
 ##isNumber
 Returns true if input is a number
 
-###Example
-```js
-> 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
@@ -136,2 +102,4 @@ Returns true if input type is `object` and not an Array
 
+**Returns** boolean 
+
 ###Example
@@ -146,4 +114,2 @@ ```js
 ```
-**Returns** boolean 
-
 ##arrayify
@@ -159,2 +125,4 @@ Takes input and guarantees an array back. Result can be one of three things:
 
+**Returns** Array 
+
 ###Example
@@ -173,4 +141,2 @@ ```js
 ```
-**Returns** Array 
-
 ##every
@@ -183,2 +149,4 @@ Returns true if the supplied iterator function returns true for every property in the object
 
+**Returns** Boolean 
+
 ###Example
@@ -193,4 +161,2 @@ ```js
 ```
-**Returns** Boolean 
-
 ##each
@@ -203,13 +169,2 @@ Runs the iterator function against every key/value pair in the input object
 
-###Example
-```js
-> var total = 0;
-undefined
-> function addToTotal(n){ total += n; }
-undefined
-> w.each({ eggs: 3, celery: 2, carrots: 1 }, addToTotal)
-undefined
-> total
-6
-```
 ##bytesToSize
@@ -222,2 +177,4 @@ Convert bytes to human-readable size
 
+**Returns** string 
+
 ###Example
@@ -234,12 +191,5 @@ ```js
 ```
-**Returns** string 
-
 ##getHomeDir
 Cross-platform home directory retriever
 
-###Example
-```js
-> w.getHomeDir()
-'/Users/Lloyd'
-```
 ##fill
@@ -252,2 +202,4 @@ Create a new string filled with the supplied character
 
+**Returns** string 
+
 ###Example
@@ -260,4 +212,2 @@ ```js
 ```
-**Returns** string 
-
 ##padRight
@@ -271,2 +221,4 @@ Add padding to the right of a string
 
+**Returns** string 
+
 ###Example
@@ -281,4 +233,2 @@ ```js
 ```
-**Returns** string 
-
 ##exists
@@ -291,2 +241,4 @@ returns true if a value, or nested object value exists in an array
 
+**Returns** boolean 
+
 ###Example
@@ -303,4 +255,2 @@ ```js
 ```
-**Returns** boolean 
-
 ##without
@@ -313,2 +263,4 @@ Returns the input array, minus the specied values
 
+**Returns** Array 
+
 ###Example
@@ -321,4 +273,2 @@ ```js
 ```
-**Returns** Array 
-
 ##first
@@ -332,2 +282,4 @@ Returns the first object in the input array with `property` set to `value`.
 
+**Returns** Object,undefined 
+
 ###Example
@@ -340,4 +292,2 @@ ```js
 ```
-**Returns** Object,undefined 
-
 ##commonDir
@@ -349,2 +299,4 @@ commonDir returns the directory common to each path in the list
 
+**Returns** string - A single path ending with the path separator, e.g. "/user/some/folder/"
+
 ###Example
@@ -365,27 +317,5 @@ ```js
 ```
-**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
-```js
-> 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
@@ -398,2 +328,4 @@ Returns the initial elements which both input arrays have in common
 
+**Returns** Array 
+
 ###Example
@@ -404,4 +336,2 @@ ```js
 ```
-**Returns** Array 
-
 ##escapeForJSON
@@ -413,2 +343,4 @@ strips special characters, making suitable for storage in a JS/JSON string
 
+**Returns** string 
+
 ###Example
@@ -419,4 +351,2 @@ ```js
 ```
-**Returns** string 
 
-

No alert changes

Worsened metrics

Total package byte prevSize

52196

decreased by-2.16%

Number of lines in readme file

321

decreased by-17.9%

No dependency changes