Extract
Last updated
Last updated
Extract the source file or folder to the destination folder using the specified format:
zip
gzip
The {@code overwrite} argument is used to overwrite the destination file if it already exists, else it will throw an exception. The default is {@code false} .
The {@code recurse} argument is used to extract the files recursively. The default is {@code true} .
The {@code filter} argument is used to filter the files to extract. It can be:
A string with a regular expression to match the file names. Example: ".*\.txt"
A Function/Lambda that receives the file name and returns a boolean. Example: (name) => name.endsWith(".txt")
The {@code entryPaths} argument is used to extract only the files that match the given paths. It can be a string or an array of strings with the paths to extract. Example: "folder1/file1.txt" or ["folder1/file1.txt", "folder2/file2.txt"]
Argument | Type | Required | Description | Default |
---|
|
|
| The format to use for the compression: zip or gzip. |
|
|
| The absolute path to the source file or folder to compress. |
|
|
| The absolute path with a file name to save as the compressed file. Extension is optional. |
|
|
| Whether to overwrite the destination file if it already exists. Default is false. |
|
|
|
| Whether to extract the files recursively. Default is true. |
|
|
|
| A regular expression or a Function/Lambda to filter the files to extract. |
|
|
| The paths to extract. It can be a string or an array of strings. |