js-7z/README.md

🏭 7zip functions in NodeJS 🏭

<img src="https://raw.githubusercontent.com/switch-app/js-7z/master/JS-7zLogo.png" width="50" height="50" alt="Logo"></img>

# Usage

## Functions

<dl>
<dt><a href="#Extract">Extract(file, out)</a></dt>
<dd><p>Extract zip file</p>
</dd>
<dt><a href="#Compress">Compress(file, folder)</a></dt>
<dd><p>Zip a folder</p>
</dd>
</dl>


## Extract(file, out)
Extract zip file

| Param | Type | Description |
| --- | --- | --- |
| file | <code>String</code> | File that we want to decompress |
| out | <code>String</code> | Folder where we want the file to be decompressed |

<a name="Compress"></a>

## Compress(file, folder)
Zip a folder

| Param | Type | Description |
| --- | --- | --- |
| file | <code>String</code> | File URL |
| folder | <code>String</code> | Folder you want to compress |