koa-cash 4.1.0 → 4.1.1

package/README.md

@@ -27,9 +27,9 @@ Table of Contents
       * [`get()`](#get)
       * [`set()`](#set)
       * [Example](#example)
-    * [Max age](#max-age)
+    * [Max age (optional)](#max-age-optional)
+    * [CashClear](#cashclear)
   * [Notes](#notes)
-  * [Usage](#usage-1)
   * [Contributors](#contributors)
   * [License](#license)
   * [Links](#links)
@@ -174,9 +174,11 @@ app.use(koaCash({
 
 See [@ladjs/koa-cache-responses](https://github.com/ladjs/koa-cache-responses) test folder more examples (e.g. Redis with `ioredis`).
 
-### Max age
+### Max age (optional)
 
-const cached = await ctx.cashed(\[maxAge])
+```js
+const cached = await ctx.cashed(maxAge) // maxAge is passed to your caching strategy
+```
 
 This is how you enable a route to be cached. If you don't call `await ctx.cashed()`, then this route will not be cached nor will it attempt to serve the request from the cache.
 
@@ -184,14 +186,20 @@ This is how you enable a route to be cached. If you don't call `await ctx.cashed
 
 If `cached` is `true`, then the current request has been served from cache and **you should early `return`**. Otherwise, continue setting `ctx.body=` and this will cache the response.
 
+### CashClear
+
+```js
+ctx.cashClear('/')
+```
+
+This is a special method available on the ctx that you can use to clear the cache for a specific key.
+
 ## Notes
 
-* Only `GET` and `HEAD` requests are cached.
+* Only `GET` and `HEAD` requests are cached. (Unless overridden)
 * Only `200` responses are cached. Don't set `304` status codes on these routes - this middleware will handle it for you
 * The underlying store should be able to handle `Date` objects as well as `Buffer` objects. Otherwise, you may have to serialize/deserialize yourself.
 
-## Usage
-
 ## Contributors
 
 | Name             | Website                   |

package/index.js

@@ -36,6 +36,12 @@ module.exports = function(options) {
   if (!get) throw new Error('.get not defined');
   if (!set) throw new Error('.set not defined');
 
+  // allow for manual cache clearing
+  function cashClear(key) {
+    // console.log(`Removing cache key: ${key}`);
+    set(key, false);
+  }
+
   // ctx.cashed(maxAge) => boolean
   async function cashed(maxAge) {
     // uncacheable request method
@@ -84,6 +90,7 @@ module.exports = function(options) {
   async function middleware(ctx, next) {
     ctx.vary('Accept-Encoding');
     ctx.cashed = cashed.bind(ctx);
+    ctx.cashClear = cashClear.bind(ctx);
 
     await next();
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "koa-cash",
   "description": "HTTP response caching for Koa. HTTP response caching for Koa.  Supports Redis, in-memory store, and more!",
-  "version": "4.1.0",
+  "version": "4.1.1",
   "author": "Jonathan Ong <me@jongleberry.com> (http://jongleberry.com)",
   "ava": {
     "verbose": true,
@@ -38,7 +38,6 @@
     "eslint": "6.x",
     "eslint-config-xo-lass": "latest",
     "fixpack": "latest",
-    "husky": "latest",
     "into-stream": "^5.1.1",
     "koa": "^2.12.0",
     "lint-staged": "latest",
@@ -46,7 +45,7 @@
     "nyc": "latest",
     "remark-cli": "latest",
     "remark-preset-github": "latest",
-    "supertest": "1.x",
+    "supertest": "latest",
     "xo": "0.25"
   },
   "engines": {
@@ -56,12 +55,6 @@
     "index.js"
   ],
   "homepage": "https://github.com/koajs/cash",
-  "husky": {
-    "hooks": {
-      "pre-commit": "lint-staged && npm test",
-      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
-    }
-  },
   "keywords": [
     "alternative",
     "amazon",