Skip to content

Latest commit

 

History

History
43 lines (30 loc) · 1.08 KB

File metadata and controls

43 lines (30 loc) · 1.08 KB

Action Decompress

(alpha version)

Decompress/extract your zip-archived template file and/or assets to the project work directory.

Installation

If you are using binary version of the nexrender, there is no need to install the module, it is included in the binary build.

npm i @nexrender/action-decompress -g

Usage

When creating your render job provide this module as one of the prerender actions:

Options:

  • format - format of the archive to decompress, currently only zip is supported
  • overwrite - if set to true, it will overwrite existing files in the project work directory on name conflict, default is false
// job.json
{
    "actions": {
        "prerender": [
            {
                "module": "@nexrender/action-decompress",
                "format": "zip",
                "overwrite": false,
            }
        ]
    }
}

License

Please refer to the LICENSE file for more information. Unlike the main nexrender project, this plugin is licensed under the AGPL-3.0 license.