cross-zip [![ci][ci-image]][ci-url] [![npm][npm-image]][npm-url] [![downloads][downloads-image]][downloads-url] [![javascript style guide][standard-image]][standard-url]

[ci-image]: https://img.shields.io/github/workflow/status/feross/cross-zip/ci/master
[ci-url]: https://github.com/feross/cross-zip/actions
[npm-image]: https://img.shields.io/npm/v/cross-zip.svg
[npm-url]: https://npmjs.org/package/cross-zip
[downloads-image]: https://img.shields.io/npm/dm/cross-zip.svg
[downloads-url]: https://npmjs.org/package/cross-zip
[standard-image]: https://img.shields.io/badge/code_style-standard-brightgreen.svg
[standard-url]: https://standardjs.com

$3

install

``
npm install cross-zip
`

usage

`js
var zip = require('cross-zip')

var inPath = path.join(__dirname, 'myFolder') // folder to zip
var outPath = path.join(__dirname, 'myFile.zip') // name of output zip file

zip.zipSync(inPath, outPath)
`

api

$3

Zip the folder at inPath and save it to a .zip file at outPath. If a callback
is passed, then it is called with an Error or null.

$3

Sync version of zip.zip.

$3

Unzip the .zip file at inPath into the folder at outPath. If a callback is
passed, then it is called with an Error or null.

$3

Sync version of zip.unzip.

Windows users

This package requires .NET Framework 4.5 or later
and Powershell 3.
These come pre-installed on Windows 8 or later.

On Windows 7 or earlier, you will need to install these manually in order for
cross-zip` to function correctly.

reference

- Stack Overflow - zipping from command line in Windows

related

- cross-zip-cli: CLI version of cross-zip.

license

MIT. Copyright (c) Feross Aboukhadijeh.