koa-cash - npm Package Compare versions

Comparing version 4.0.1 to 4.0.3

index.js

@@ -20,3 +20,3 @@ const { gzip } = require('zlib');
 module.exports = function(options) {
-  options = options || {};
+  options = options || { compression: false };
 
@@ -63,2 +63,3 @@ const hash =
     if (
+      options.compression &&
       obj.gzip &&
@@ -72,3 +73,5 @@ this.request.acceptsEncodings('gzip', 'identity') === 'gzip'
       // tell any compress middleware to not bother compressing this
-      this.response.set('Content-Encoding', 'identity');
+      if (options.compression) {
+        this.response.set('Content-Encoding', 'identity');
+      }
     }
@@ -126,3 +129,7 @@
 
-    if (compressible(obj.type) && ctx.response.length >= threshold) {
+    if (
+      options.compression &&
+      compressible(obj.type) &&
+      ctx.response.length >= threshold
+    ) {
       obj.gzip = await compress(body);
@@ -129,0 +136,0 @@ if (

package.json

 {
   "name": "koa-cash",
   "description": "HTTP response caching for Koa. HTTP response caching for Koa.  Supports Redis, in-memory store, and more!",
-  "version": "4.0.1",
+  "version": "4.0.3",
   "author": "Jonathan Ong <[e-mail]> (http://jongleberry.com)",
@@ -6,0 +6,0 @@ "ava": {

README.md

@@ -33,3 +33,3 @@ # koa-cash
 * Handles JSON and stream bodies
-* Handles gzip compression negotiation
+* Handles gzip compression negotiation (if `options.compression` is set to `true` as of v4.0.0)
 * Handles 304 responses
@@ -90,2 +90,6 @@
 
+#### `compression`
+
+If a truthy value is passed, then compression will be enabled.  This value is `false` by default.
+
 #### `hash()`
@@ -92,0 +96,0 @@

test/when-cached.js

@@ -18,3 +18,4 @@ const LRU = require('lru-cache');
           return c.set(key, value);
-        }
+        },
+        compression: true
       }
@@ -21,0 +22,0 @@ )

test/when-not-cached.js

@@ -19,3 +19,4 @@ const Koa = require('koa');
           return c.set(key, value);
-        }
+        },
+        compression: true
       }
@@ -39,3 +40,4 @@ )
       return c.set(key, value);
-    }
+    },
+    compression: true
   });
@@ -174,3 +176,4 @@
         return c.set(key, JSON.stringify(value));
-      }
+      },
+      compression: true
     });
@@ -177,0 +180,0 @@ app.use(async function(ctx) {

Fixed alerts

Deprecated

Maintenance

The maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

24007

1.77%

Lines of code

534

2.1%

Number of medium maintenance alerts

0

-100%

Number of lines in readme file

190

2.15%

No dependency changes