slonik-interceptor-query-cache 3.0.0 → 3.2.0

package/README.md

@@ -18,11 +18,33 @@ Which queries are cached is controlled using cache attributes. 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-discard-empty`|If set to `true`, then `storage.set` is not invoked when query produces no results.|No|`/^(false|true)$/`|`false`|
+#### `@cache-ttl`
+
+|Required|Format|Default|
+|---|---|---|
+|Yes|`/^d+$/`|N/A|
+
+Number (in seconds) to cache the query for.
+
+#### `@cache-key`
+
+|Required|Format|Default|
+|---|---|---|
+|No|`/^[$A-Za-z0-9\-_:]+$/`|`$bodyHash:$valueHash`|
+
+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).
+
+If present, `$valueHash` is substituted with the hash of the parameter values.
+
+#### `@cache-discard-empty`
+
+|Required|Format|Default|
+|---|---|---|
+|No|`/^(false|true)$/`|`false`|
+
+If set to `true`, then `storage.set` is not invoked when query produces no results.
 
 ### Example usage
 

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.2.0"
 }