Inlife/nexrender

View on GitHub
packages/nexrender-action-cache/readme.md

Summary

Maintainability
Test Coverage
# Action: Cache

Cache your template source to a specified location and reuse it on subsequent runs

## Installation

```
npm i -g @nexrender/action-cache
```

## Usage

When creating your render job provide this module in **both** of the `predownload` and `postdownload` actions:

## Additional Params
- ttl (optional): a time-to-live in milliseconds for which after that the cached item is invalidated
- cacheAssets (optional): a boolean value that if true will cache the assets used by a job as well. Note that assets with the same filename will overwrite each other in the cache so should be avoided if using assets cache.

```js
// job.json
{
    "actions": {
        "predownload": [
            {
                "module": "@nexrender/action-cache",
                "cacheDirectory": "~/cache",
                "ttl": 3600000
            }
        ],
        "postdownload": [
            {
                "module": "@nexrender/action-cache",
                "cacheDirectory": "~/cache"
            }
        ],
    }
}
```