@travetto/cache 3.0.2 → 3.0.3

package/README.md

@@ -1,6 +1,7 @@
 <!-- This file was generated by @travetto/doc and should not be modified directly -->
-<!-- Please modify https://github.com/travetto/travetto/tree/main/module/cache/DOC.ts and execute "npx trv doc" to rebuild -->
+<!-- Please modify https://github.com/travetto/travetto/tree/main/module/cache/DOC.tsx and execute "npx trv doc" to rebuild -->
 # Caching
+
 ## Caching functionality with decorators for declarative use.
 
 **Install: @travetto/cache**
@@ -24,9 +25,7 @@ npm install @travetto/model-{provider}
 
 yarn add @travetto/model-{provider}
 ```
-
 Currently, the following are packages that provide [Expiry](https://github.com/travetto/travetto/tree/main/module/model/src/service/expiry.ts#L11):
-   
    *  [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.") - @travetto/model: [FileModelService](https://github.com/travetto/travetto/tree/main/module/model/src/provider/file.ts#L51), [MemoryModelService](https://github.com/travetto/travetto/tree/main/module/model/src/provider/memory.ts#L54)
    *  [DynamoDB Model Support](https://github.com/travetto/travetto/tree/main/module/model-dynamodb#readme "DynamoDB backing for the travetto model module.") - @travetto/model-dynamodb
    *  [Elasticsearch Model Source](https://github.com/travetto/travetto/tree/main/module/model-elasticsearch#readme "Elasticsearch backing for the travetto model module, with real-time modeling support for Elasticsearch mappings.") - @travetto/model-elasticsearch
@@ -69,13 +68,11 @@ export class Worker {
 }
 ```
 
-### [@Cache](https://github.com/travetto/travetto/tree/main/module/cache/src/decorator.ts#L13)
-
+### Cache
 The [@Cache](https://github.com/travetto/travetto/tree/main/module/cache/src/decorator.ts#L13) decorator supports configurations on:
-
-   
    *  `name` the field name of the current class which points to the desired cache source.
-   *  `config` the additional/optional config options, on a per invocation basis    
+   *  `config` the additional/optional config options, on a per invocation basis
+
       *  `keySpace` the key space within the cache.  Defaults to class name plus method name.
       *  `key` the function  will use the inputs to determine the cache key, defaults to all params `JSON.stringify`ied
       *  `params` the function used to determine the inputs for computing the cache key.  This is an easier place to start to define what parameters are important in ,caching. This defaults to all inputs.
@@ -84,8 +81,7 @@ The [@Cache](https://github.com/travetto/travetto/tree/main/module/cache/src/dec
       *  `serialize` the function to execute before storing a cacheable value.  This allows for any custom data modification needed to persist as a string properly.
       *  `reinstate` the function to execute on return of a cached value.  This allows for any necessary operations to conform to expected output (e.g. re-establishing class instances, etc.).  This method should not be used often, as the return values of the methods should naturally serialize to/from `JSON` and the values should be usable either way.
 
-### [@EvictCache](https://github.com/travetto/travetto/tree/main/module/cache/src/decorator.ts#L40)
-
+### EvictCache
 Additionally, there is support for planned eviction via the [@EvictCache](https://github.com/travetto/travetto/tree/main/module/cache/src/decorator.ts#L40) decorator.  On successful execution of a method with this decorator, the matching keySpace/key value will be evicted from the cache.  This requires coordination between multiple methods, to use the same `keySpace` and `key` to compute the expected key.
 
 **Code: Using decorators to cache/evict user access**
@@ -122,7 +118,6 @@ export class UserService {
 ```
 
 ## Extending the Cache Service
-
 By design, the [CacheService](https://github.com/travetto/travetto/tree/main/module/cache/src/service.ts#L29) relies solely on the [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.") module.  Specifically on the [Expiry](https://github.com/travetto/travetto/tree/main/module/model/src/service/expiry.ts#L11).   This combines basic support for CRUD as well as knowledge of how to manage expirable content.  Any model service that honors these contracts is a valid candidate to power the [CacheService](https://github.com/travetto/travetto/tree/main/module/cache/src/service.ts#L29).  The [CacheService](https://github.com/travetto/travetto/tree/main/module/cache/src/service.ts#L29) is expecting the model service to be registered using the @travetto/cache:model:
 
 **Code: Registering a Custom Model Source**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/cache",
-  "version": "3.0.2",
+  "version": "3.0.3",
   "description": "Caching functionality with decorators for declarative use.",
   "keywords": [
     "typescript",
@@ -25,12 +25,12 @@
     "directory": "module/cache"
   },
   "dependencies": {
-    "@travetto/di": "^3.0.2",
-    "@travetto/model": "^3.0.2"
+    "@travetto/di": "^3.0.3",
+    "@travetto/model": "^3.0.3"
   },
   "peerDependencies": {
-    "@travetto/test": "^3.0.2",
-    "@travetto/transformer": "^3.0.2"
+    "@travetto/test": "^3.0.3",
+    "@travetto/transformer": "^3.0.3"
   },
   "peerDependenciesMeta": {
     "@travetto/transformer": {