array-comprehensions - npm Package Compare versions

Comparing version 0.5.1 to 0.5.2

package.json

 {
   "name": "array-comprehensions",
-  "version": "0.5.1",
+  "version": "0.5.2",
   "description": "Array comprehensions",
@@ -5,0 +5,0 @@ "main": "forOf.js",

README.md

@@ -43,1 +43,39 @@ array-comprehensions
 ```
+
+API
+---
+
+### forOf
+
+#### `forOf(iterable, do)`
+
+Execute the function `do` for each item of `iterable`.
+
+```js
+forOf([1, 2, 3], function(x){
+  return x+1;
+}); // => [2, 3, 4]
+```
+
+#### `forOf(iterable, condition, do)`
+
+Execute the function `do` for each item of `iterable` that fullfills the `condition`.
+
+```js
+forOf([1, 2, 3, 4], function(x) {
+  return x % 2 === 0;
+}, function(x) {
+  return x*x;
+}); // => [4,16]
+```
+
+#### `forOf(iterable1, iterable2, do)`
+
+Execute the function `do` for each item of `iterable1` with every item of `iterable2`.
+
+```js
+forOf([1, 2], [1,2], function(x, y) {
+  return x*y;
+}); // => [1,2,2,4]
+```
+

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

5517

increased by12.94%

Number of lines in readme file

81

increased by88.37%

No dependency changes