eden-array - npm Package Compare versions

Comparing version 0.0.20 to 0.0.21

package.json

 {
   "name": "eden-array",
   "description": "Eden Node JS Array Methods",
-  "version": "0.0.20",
+  "version": "0.0.21",
   "author": {
@@ -18,4 +18,4 @@ "name": "Christian Blanquera",
   "dependencies": {
-	"eden-class": "0.0.20",
-	"eden-hash": "0.0.20"
+	"eden-class": "0.0.21",
+	"eden-hash": "0.0.21"
   },
@@ -22,0 +22,0 @@ "main": "./array.js",

README.md

@@ -1,6 +0,771 @@
-array
-=====
+#Array
 
+DESCRIPTION
+
 [![Build Status](https://api.travis-ci.org/edenjs/array.png)](https://travis-ci.org/edenjs/array)
 
-Eden Node JS ArrayMethods
+## General
+
+### Installation
+
+```
+npm install eden-array
+```
+
+### Usage
+
+```
+var array = require('eden-array');
+```
+
+## Methods
+
+  * [clone](#clone)
+
+  * [combine](#combine)
+
+  * [concat](#concat)
+
+  * [each](#each)
+
+  * [implode](#implode)
+
+  * [isEmpty](#isEmpty)
+
+  * [keys](#keys)
+
+  * [lastIndexOf](#lastIndexOf)
+
+  * [map](#map)
+
+  * [natsort](#natsort)
+
+  * [pop](#pop)
+
+  * [push](#push)
+
+  * [reverse](#reverse)
+
+  * [splice](#splice)
+
+  * [sort](#sort)
+
+  * [size](#size)
+
+  * [toQuery](#toQuery)
+
+  * [toString](#toString)
+
+  * [unshift](#unshift)
+
+  * [values](#values)
+
+---
+
+<a name="clone"></a>
+
+### clone
+
+```
+ array clone(Array);
+```
+
+Clones an array
+
+#### Parameters
+
+  1. array
+
+#### Returns
+
+ array
+
+#### Example
+
+##### Code
+
+```
+array().clone();
+```
+
+##### Outputs
+
+```
+RESULTS
+```
+
+---
+
+<a name="combine"></a>
+
+### combine
+
+```
+ object combine(Array, Array);
+```
+
+Combines a list of keys and values into an object
+
+#### Parameters
+
+  1. array
+
+  2. array
+
+#### Returns
+
+ object
+
+#### Example
+
+##### Code
+
+```
+array().combine();
+```
+
+##### Outputs
+
+```
+RESULTS
+```
+
+---
+
+<a name="concat"></a>
+
+### concat
+
+```
+ this concat(Array[,array..]);
+```
+
+Concats arrays into one
+
+#### Parameters
+
+  1. array[,array..]
+
+#### Returns
+
+ this
+
+#### Example
+
+##### Code
+
+```
+array().concat();
+```
+
+##### Outputs
+
+```
+RESULTS
+```
+
+---
+
+<a name="each"></a>
+
+### each
+
+```
+ bool each(Array, Function);
+```
+
+Custom for each loop that handles scopes and extra arguments
+
+#### Parameters
+
+  1. array
+
+  2. function
+
+#### Returns
+
+ bool
+
+#### Example
+
+##### Code
+
+```
+array().each();
+```
+
+##### Outputs
+
+```
+RESULTS
+```
+
+---
+
+<a name="implode"></a>
+
+### implode
+
+```
+ string implode(Array, Mixed, Boolis.has, Array, String);
+```
+
+Returns true if the array has given value
+
+#### Parameters
+
+  1. array
+
+  2. mixed
+
+  3. boolis.has - = function(data, value) {Argument Testingis.argument()est(1, 'array')est(1, 'mixed');turn data.indexOf(value) !== -1;*Join array elements with a string
+
+  4. array
+
+  5. string
+
+#### Returns
+
+ string
+
+#### Example
+
+##### Code
+
+```
+array().implode();
+```
+
+##### Outputs
+
+```
+RESULTS
+```
+
+---
+
+<a name="isEmpty"></a>
+
+### isEmpty
+
+```
+ bool isEmpty(Array);
+```
+
+Check if data is array @param array @return bool 
+
+#### Parameters
+
+  1. array
+
+#### Returns
+
+ bool
+
+#### Example
+
+##### Code
+
+```
+array().isEmpty();
+```
+
+##### Outputs
+
+```
+RESULTS
+```
+
+---
+
+<a name="keys"></a>
+
+### keys
+
+```
+ array keys(Array);
+```
+
+Returns a list of keys
+
+#### Parameters
+
+  1. array
+
+#### Returns
+
+ array
+
+#### Example
+
+##### Code
+
+```
+array().keys();
+```
+
+##### Outputs
+
+```
+RESULTS
+```
+
+---
+
+<a name="lastIndexOf"></a>
+
+### lastIndexOf
+
+```
+ number lastIndexOf(Array, Mixed);
+```
+
+Returns the last index of where in the array the value is found
+
+#### Parameters
+
+  1. array
+
+  2. mixed
+
+#### Returns
+
+ number
+
+#### Example
+
+##### Code
+
+```
+array().lastIndexOf();
+```
+
+##### Outputs
+
+```
+RESULTS
+```
+
+---
+
+<a name="map"></a>
+
+### map
+
+```
+ array map(Array, Function, [mixed[,mixed..]]);
+```
+
+Custom map loop that handles scopes and extra arguments
+
+#### Parameters
+
+  1. array
+
+  2. function
+
+  3. [mixed[,mixed..]]
+
+#### Returns
+
+ array
+
+#### Example
+
+##### Code
+
+```
+array().map();
+```
+
+##### Outputs
+
+```
+RESULTS
+```
+
+---
+
+<a name="natsort"></a>
+
+### natsort
+
+```
+ object natsort(Object);
+```
+
+Sorts array by natural sort
+
+#### Parameters
+
+  1. object
+
+#### Returns
+
+ object
+
+#### Example
+
+##### Code
+
+```
+array().natsort();
+```
+
+##### Outputs
+
+```
+RESULTS
+```
+
+---
+
+<a name="pop"></a>
+
+### pop
+
+```
+ mixed pop(Array);
+```
+
+Pops array from the stack
+
+#### Parameters
+
+  1. array
+
+#### Returns
+
+ mixed
+
+#### Example
+
+##### Code
+
+```
+array().pop();
+```
+
+##### Outputs
+
+```
+RESULTS
+```
+
+---
+
+<a name="push"></a>
+
+### push
+
+```
+ array push(Array, Mixed[,mixed..]);
+```
+
+Pushes array into the stack
+
+#### Parameters
+
+  1. array
+
+  2. mixed[,mixed..]
+
+#### Returns
+
+ array
+
+#### Example
+
+##### Code
+
+```
+array().push();
+```
+
+##### Outputs
+
+```
+RESULTS
+```
+
+---
+
+<a name="reverse"></a>
+
+### reverse
+
+```
+ array reverse(Array);
+```
+
+Reverses the array
+
+#### Parameters
+
+  1. array
+
+#### Returns
+
+ array
+
+#### Example
+
+##### Code
+
+```
+array().reverse();
+```
+
+##### Outputs
+
+```
+RESULTS
+```
+
+---
+
+<a name="splice"></a>
+
+### splice
+
+```
+ array splice(Array, Num, Num, Mixed[,mixed..]);
+```
+
+Picks from chosen slice and rconturns a new array @param array @param num @param [num] @return array  is.slice = function(data) { Argument Testing is.argument() est(1, 'array') est(2, 'int') est(3, 'int', 'undefined');  r args = Array.prototype.slice.apply(arguments); gs.shift(); turn data.slice.apply(data, args);   * Adds/removes items to/from an array, and returns the removed item(s)
+
+#### Parameters
+
+  1. array
+
+  2. num
+
+  3. num
+
+  4. mixed[,mixed..]
+
+#### Returns
+
+ array
+
+#### Example
+
+##### Code
+
+```
+array().splice();
+```
+
+##### Outputs
+
+```
+RESULTS
+```
+
+---
+
+<a name="sort"></a>
+
+### sort
+
+```
+ array sort(Array, [function]);
+```
+
+Sorts an array
+
+#### Parameters
+
+  1. array
+
+  2. [function]
+
+#### Returns
+
+ array
+
+#### Example
+
+##### Code
+
+```
+array().sort();
+```
+
+##### Outputs
+
+```
+RESULTS
+```
+
+---
+
+<a name="size"></a>
+
+### size
+
+```
+ number size(Array);
+```
+
+Returns the array size
+
+#### Parameters
+
+  1. array
+
+#### Returns
+
+ number
+
+#### Example
+
+##### Code
+
+```
+array().size();
+```
+
+##### Outputs
+
+```
+RESULTS
+```
+
+---
+
+<a name="toQuery"></a>
+
+### toQuery
+
+```
+ string toQuery(String, [string]);
+```
+
+Converts array to query string
+
+#### Parameters
+
+  1. string
+
+  2. [string]
+
+#### Returns
+
+ string
+
+#### Example
+
+##### Code
+
+```
+array().toQuery();
+```
+
+##### Outputs
+
+```
+RESULTS
+```
+
+---
+
+<a name="toString"></a>
+
+### toString
+
+```
+ string toString();
+```
+
+Converts array to string
+
+#### Parameters
+
+#### Returns
+
+ string
+
+#### Example
+
+##### Code
+
+```
+array().toString();
+```
+
+##### Outputs
+
+```
+RESULTS
+```
+
+---
+
+<a name="unshift"></a>
+
+### unshift
+
+```
+ array unshift(Array, Mixed[,mixed..]);
+```
+
+Unshifts array into the stack
+
+#### Parameters
+
+  1. array
+
+  2. mixed[,mixed..]
+
+#### Returns
+
+ array
+
+#### Example
+
+##### Code
+
+```
+array().unshift();
+```
+
+##### Outputs
+
+```
+RESULTS
+```
+
+---
+
+<a name="values"></a>
+
+### values
+
+```
+ array values(Array);
+```
+
+Returns a list of values
+
+#### Parameters
+
+  1. array
+
+#### Returns
+
+ array
+
+#### Example
+
+##### Code
+
+```
+array().values();
+```
+
+##### Outputs
+
+```
+RESULTS
+```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

20131

increased by45.82%

Number of lines in readme file

772

increased by10928.57%

Dependency changes

• + Addededen-class@0.0.21(transitive)

• + Addededen-hash@0.0.21(transitive)

• + Addedsyncopate@0.0.4(transitive)

• - Removededen-class@0.0.20(transitive)

• - Removededen-hash@0.0.20(transitive)

• - Removedsyncopate@0.0.3(transitive)

• Updatededen-class@0.0.21

• Updatededen-hash@0.0.21