async-deco - npm Package Compare versions

Comparing version 3.1.0 to 3.2.0

package.json

 {
   "name": "async-deco",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "description": "A collection of decorators for adding features to asynchronous functions (callback or promise based).",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -105,2 +105,19 @@ async-deco
 
+Proxy
+-----
+It executes a "guard" function before the original one. If it returns an error it will use this error as the return value of the original function. 
+It is useful if you want to run a function only if it passes some condition (access control).
+```js
+var proxyDecorator = require('async-deco/callback/proxy');
+
+var proxy = cacheDecorator(function (..., cb) {
+  // calls cb(errorInstance) if the access is denied
+  // calls cb() if I can procede calling the function
+}, logger);
+var myfunc = proxy(function (..., cb) { .... });
+```
+It takes 2 arguments:
+* a guard function [mandatory]. It takes the same arguments of the original function. If it returns an error (using the callback) the original function won't be called.
+* a logger function (logs "access denied") [optional]
+
 Fallback
@@ -107,0 +124,0 @@ --------

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

79999

increased by5.3%

Number of package files

74

increased by7.25%

Lines of code

2267

increased by5.39%

Number of lines in readme file

317

increased by5.67%

No dependency changes