Skip to content

File Compress

Compress multiple files into a single archive.

Files are compressed on-the-fly, typically using minimal memory footprint, regardless of the size or number of files. This design allows the node to compress files and directories without the need to first store them in a temporary compressed file. Although only one processor is utilized for compression, the performance and throughput should be sufficient for most use cases.

Inputs#

Port Description
Starts the compression process.
Format
Select the format for the compressed archive. Compression level is ignored for tar.
Base Path
Optional base path to prefix to each file before compression.
Level
Set the compression level from 0 (no compression) to 9 (maximum compression). Levels outside this range will be clamped. Note: This is ignored when using the tar format.
Paths
List of file or directory paths to be compressed into the archive. Directory paths are recursively traversed to include all files and subdirectories. If a file path is is provided that is also in a provided directory path, the file will only be included once.

Outputs#

Port Description
Success
Triggered when compression is successful.
Error
Triggered if an error occurs during compression.
Suffix
Returns the file extension of the compressed archive for convinience (e.g., .zip, .tar.gz).
Data
The binary data of the compressed archive.

ID: file-compress@v1