Forgot to make Wiki changes for compression stuff.

That_One_Nerd 2023-04-01 14:58:26 -04:00
parent 89373c22ae
commit fd116ba9c5
2 changed files with 125 additions and 2 deletions

@ -266,8 +266,60 @@ View the text currently stored in your clipboard. Due to some issues with clipbo
### `compress`
#### `compress gz`, `compress gzip`
Compresses a single file into a GZip file.
Parameters:
- source: `string`
- The original location of the file.
- destination: `string?`
- The destination for the compressed file. If set to `null`, it will be determined automatically.
- Default Value: `null`
- level: `CompressionLevel`
- The level of compression for the GZip file. The compression level also changes the time it takes to compress.
- Default Value: `Optimal`
- Possible Values:
- `Optimal`
- `Fastest`
- `NoCompression`
- `SmallestSize`
---
#### `compress tar`, `compress tarball`
Compresses a file or directory into a single Tar file. Tar files technically do not compress their contents and simply pack them. That is why they are usually compressed into a GZip file.
Parameters:
- source: `string`
- The original location of the file or directory.
- destination: `string?`
- The destination for the compressed file or directory. If set to `null`, it will be determined automatically.
- Default Value: `null`
---
#### `compress targz`, `compress tar.gz`, `compress tar-gz`
First packs a file or directory into a single Tar file, then compresses that file into a GZip file.
Parameters:
- source: `string`
- The original location of the file or directory.
- destination: `string?`
- The destination for the compressed GZip file. If set to `null`, it will be determined automatically.
- Default Value: `null`
- level: `CompressionLevel`
- The level of compression for the GZip file. The compression level also changes the time it takes to compress.
- Default Value: `Optimal`
- Possible Values:
- `Optimal`
- `Fastest`
- `NoCompression`
- `SmallestSize`
---
#### `compress zip`
Compresses a file or directory into a single `.zip` file.
Compresses a file or directory into a single Zip file.
Parameters:
- source: `string`
@ -276,10 +328,80 @@ Parameters:
- The destination for the compressed file or directory. If set to `null`, it will be determined automatically.
- Default Value: `null`
- level: `CompressionLevel`
- The level of compression for the `.zip` file. The compression level also changes the time it takes to compress.
- The level of compression for the Zip file. The compression level also changes the time it takes to compress.
- Default Value: `Optimal`
- Possible Values:
- `Optimal`
- `Fastest`
- `NoCompression`
- `SmallestSize`
---
### `extract`
#### `extract gz`, `extract gzip`
Extracts the contents of a GZip file and saves it to a file.
Parameters:
- source: `string`
- The original location of the GZip file.
- destination: `string?`
- The destination of the file extracted from the GZip file. If set to `null`, it will be determined automatically.
- Default Value: `null`
---
#### `extract rar`
Extracts the contents of a Rar file and saves it to a directory.
Parameters:
- source: `string`
- The original location of the Rar file.
- destination: `string?`
- The destination of the files extracted from the Rar file. If set to `null`, it will be determined automatically.
- Default Value: `null`
---
#### `extract tar`, `extract tarball`
Extracts the contents of a Tar file and saves it to a directory.
Parameters:
- source: `string`
- The original location of the Tar file.
- destination: `string?`
- The destination of the files extracted from the Tar file. If set to `null`, it will be determined automatically.
- Default Value: `null`
#### `extract targz`, `extract tar.gz`, `extract tar-gz`
Extracts the contents of a Tar and GZip file combination and saves it to a directory.
Parameters:
- source: `string`
- The original location of the GZip file.
- destination: `string?`
- The destination of the files extracted from the Tar file. If set to `null`, it will be determined automatically.
- Default Value: `null`
---
#### `extract zip`
Extracts the contents of a Zip file and saves it to a directory.
Parameters:
- source: `string`
- The original location of the Zip file.
- destination: `string?`
- The destination of the files extracted from the Zip file. If set to `null`, it will be determined automatically.
- Default Value: `null`
#### `extract rar`
Extracts the contents of a 7Zip file and saves it to a directory.
Parameters:
- source: `string`
- The original location of the 7Zip file.
- destination: `string?`
- The destination of the files extracted from the 7Zip file. If set to `null`, it will be determined automatically.
- Default Value: `null`

@ -44,3 +44,4 @@ These are the name, prefix, and brief descriptions of each module implemented by
| `BaseModule` | `base` (not prefixed) | A module with most system commands. Does not contain any modding functionality. |
| `ClipboardModule` | `clipboard` | A module that handles commands related to the system clipboard. |
| `CompressionModule` | `compress` | A module that handles compression to certain formats. |
| `ExtractionModule` | `extract` | A module that handles extraction from certain compression formats. |