slonik-interceptor-query-cache 3.0.0 → 3.1.0

package/README.md

@@ -21,9 +21,15 @@ Which queries are cached is controlled using cache attributes. Cache attributes
 |Cache attribute|Description|Required?|Format|Default|
 |---|---|---|---|---|
 |`@cache-ttl`|Number (in seconds) to cache the query for.|Yes|`/^d+$/`|N/A|
-|`@cache-key`|Uniquelly identifies the query. Overrides the default cache key that uniquely identifies the query. If present, `$bodyHash` is substituted with the hash of the query (comments and white-spaces are stripped before hashing the query). `$valueHash` is substituted with the hash of the parameter values.|No|`/^[$A-Za-z0-9\-_:]+$/`|`$bodyHash:$valueHash`|
+|`@cache-key`|Cache key that uniquelly identifies the query.|No|`/^[$A-Za-z0-9\-_:]+$/`|`$bodyHash:$valueHash`|
 |`@cache-discard-empty`|If set to `true`, then `storage.set` is not invoked when query produces no results.|No|`/^(false|true)$/`|`false`|
 
+### `@cache-key`
+
+Overrides the default cache key that uniquely identifies the query.
+
+If present, `$bodyHash` is substituted with the hash of the query (comments and white-spaces are stripped before hashing the query). `$valueHash` is substituted with the hash of the parameter values.
+
 ### Example usage
 
 This example shows how to create a compatible storage service using [`node-cache`](https://www.npmjs.com/package/node-cache).

package/package.json

@@ -67,5 +67,5 @@
     "test:ava": "nyc ava --verbose --serial"
   },
   "typings": "./dist/src/index.d.ts",
-  "version": "3.0.0"
+  "version": "3.1.0"
 }