JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 245249
  • Score
    100M100P100Q170654F
  • License MIT

Cross-platform .zip file creation

Package Exports

  • cross-zip
  • cross-zip/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (cross-zip) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

cross-zip ci npm downloads javascript style guide

Cross-platform .zip file creation

install

npm install cross-zip

usage

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

zip.zip(inPath, outPath, [callback])

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.

zip.zipSync(inPath, outPath)

Sync version of zip.zip.

zip.unzip(inPath, outPath, [callback])

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.

zip.unzipSync(inPath, outPath)

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

license

MIT. Copyright (c) Feross Aboukhadijeh.