function-tools - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

example/throttle.js

@@ -0,1 +1,2 @@
+"use strict";
 var f = require("../");
@@ -2,0 +3,0 @@

lib/function-tools.js

@@ -7,2 +7,6 @@ "use strict";
 @alias f
+@example
+```js
+var f = require("function-tools");
+```
 */
@@ -14,5 +18,11 @@ exports.throttle = throttle;
 @param {Function} - the function to throttle
-@param {Object} - options
+@param [options] {Object} - the options
+@param [options.restPeriod] {number} - a value in ms
 @returns {Function}
 @alias module:function-tools.throttle
+@example
+```js
+var throttled = f.throttle(myFunction, { restPeriod: 200 });
+throtted(); // this will only execute if at least 200ms since the last invocation
+```
 */
@@ -36,3 +46,3 @@ function throttle(f, options){
         }
-    }
+    };
 }

package.json

 {
   "name": "function-tools",
   "author": "Lloyd Brookes <[e-mail]>",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Useful higher-order functions",
@@ -11,3 +11,5 @@ "repository": "https://github.com/75lb/function-tools.git",
   },
-  "keywords": [],
+  "keywords": [
+    "throttle"
+  ],
   "engines": {
@@ -22,5 +24,5 @@ "node": ">=0.10.0"
   "devDependencies": {
-    "jsdoc-to-markdown": "^0.1.9",
+    "jsdoc-to-markdown": "^0.5",
     "tape": "^2.13.3"
   }
 }

README.md

@@ -6,42 +6,27 @@ [![view on npm](http://img.shields.io/npm/v/function-tools.svg)](https://www.npmjs.org/package/function-tools)
 
-
+<a name="module_function-tools"></a>
 #function-tools
 Useful higher-order functions
 
+**Example**  
+```js
+var f = require("function-tools");
+```
 
-
-
-
-
-
-
-
-**Contents**
-* [throttle(f, options)](#module_function-tools.throttle)
-
-
-
-
-
-
-
 <a name="module_function-tools.throttle"></a>
-###f.throttle(f, options)
+##f.throttle(f, [options])
 Guarantees a function a specified `restPeriod` in between invocations.
 
+**Params**
 
-- f `function` the function to throttle  
-- options `Object` options  
+- f `function` - the function to throttle  
+- \[options\] `Object` - the options  
+  - \[restPeriod\] `number` - a value in ms  
 
+**Returns**: `function`  
+**Example**  
+```js
+var throttled = f.throttle(myFunction, { restPeriod: 200 });
+throtted(); // this will only execute if at least 200ms since the last invocation
+```
 
-**Returns**: `function`
-
-
-
-
-
-
-
-
-
-

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

4632

increased by13.47%

Lines of code

73

increased by17.74%

Worsened metrics

Number of lines in readme file

32

decreased by-31.91%

No dependency changes