Welcome to zip-folder-promise 👋
> Use [Archiver](https://github.com/archiverjs/node-archiver) to zip a folder using promises instead of callbacks.
## Install
```sh
$ npm install --save zip-folder-promise
```
## Usage
```typescript
zipFolder(
inputDir: string,
outputFileName: string,
format?: 'tar' | 'zip',
subDirectory?: string
): Promise
```
### Example:
```javascript
const zipFolderPromise = require('zip-folder-promise');
async function yourAsyncFn() {
try {
// ..
// Using default ZIP format
const zipFolderMsg = await zipFolder('dirName', 'zipName');
console.log(zipFolderMsg);
// Using a subDirectory to wrap your files
const zipFolderMsgSubdirectory = await zipFolder('dirName', 'zipName', 'zip', 'subdirectoryFolder');
console.log(zipFolderMsgSubdirectory);
// Using alternate TAR format
const tarFolderMsg = await zipFolder('dirName', 'tarName', 'tar');
console.log(tarFolderMsg);
// ..
}
catch(err) {
// Handler error
}
}
```
## Author
👤 **Ricardo Tribaldos (https://barustudio.com)**
* Github: [@tribal2](https://github.com/tribal2)
* Twitter: [@r_tribaldos](https://twitter.com/r_tribaldos)
* LinkedIn: [@rtribaldos](https://linkedin.com/in/rtribaldos)
## Show your support
Give a ⭐️ if this project helped you!
## 📝 License
Copyright © 2022 [Ricardo Tribaldos (https://barustudio.com)](https://github.com/tribal2).
This project is [MIT](https://github.com/tribal2/zip-folder-promise/blob/master/LICENSE) licensed.
***
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_