Welcome to zip-folder-promise 👋

Use Archiver to zip a folder using promises instead of callbacks.

Install

1$ npm install --save zip-folder-promise

Usage

1zipFolder(
2  inputDir: string,
3  outputFileName: string,
4  format?: 'tar' | 'zip',
5  subDirectory?: string
6): Promise<string>

Example:

1const zipFolderPromise = require('zip-folder-promise');
2
3async function yourAsyncFn() {
4  try {
5    // ..
6    // Using default ZIP format
7    const zipFolderMsg = await zipFolder('dirName', 'zipName');
8    console.log(zipFolderMsg);
9
10    // Using a subDirectory to wrap your files
11    const zipFolderMsgSubdirectory = await zipFolder('dirName', 'zipName', 'zip', 'subdirectoryFolder');
12    console.log(zipFolderMsgSubdirectory);
13
14    // Using alternate TAR format
15    const tarFolderMsg = await zipFolder('dirName', 'tarName', 'tar');
16    console.log(tarFolderMsg);
17    // ..
18  }
19
20  catch(err) {
21    // Handler error
22  }
23}

Author

👤 Ricardo Tribaldos (https://barustudio.com)

• Github: @tribal2
• Twitter: @r_tribaldos
• LinkedIn: @rtribaldos

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2022 Ricardo Tribaldos (https://barustudio.com).
This project is MIT licensed.

---

This README was generated with ❤️ by readme-md-generator