Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

pizzip

open-xml-templating551.2k(MIT OR GPL-3.0)3.2.0TypeScript support: included

Create, read and edit .zip files synchronously with Javascript

zip, deflate, inflate

readme

PizZip

PizZip is a fork of JSZip version 2.x, because we want a synchronous Zip library.

A library for creating, reading and editing .zip files with Javascript, with a lovely and simple API.

var zip = new PizZip();

zip.file("Hello.txt", "Hello World\n");

var img = zip.folder("images");
img.file("smile.gif", imgData, { base64: true });

var content = zip.generate({ type: "blob" });

// see FileSaver.js
saveAs(content, "example.zip");

/*
Results in a zip containing
Hello.txt
images/
    smile.gif
*/

License

PizZip is dual-licensed. You may use it under the MIT license or the GPLv3 license. See LICENSE.markdown.

changelog

title: Changelog layout: default

section: main

v3.2.0

Add support for fileOrder in the .generate() function.

v3.1.8

The following message was shown in PizZipUtils.getBinaryContent:

InvalidStateError: Failed to read the 'responseText'

This meant that the server didn't respond or that there is a CORS issue.

The message is now : "Ajax error, status 0 Server not responding or CORS headers missing."

v3.1.7

Change ArrayBuffer check to work correctly with webworkers

Fixes #36

v3.1.6

Improve typescript support :

Fixes following error message :

error TS1259: Module 'pizzip' can only be default-imported using the 'allowSyntheticDefaultImports' flag
Error - 'tsc' sub task errored after 2.66 s

v3.1.5

Use pako.min.js instead of pako.js

v3.1.4

Remove @babel from dependencies (moved to devDependencies)

v3.1.3

Update typescript typings to work correctly.

v3.1.2

Add typescript typings

v3.1.1

  • Add zip.clone() function to deep clone a zip instance

  • Remove usage of new Buffer in favor of Buffer.from() or Buffer.alloc()

v3.1.0

Update pako to v2

When using new Pizzip(promise), show specific error message

v3.0.5

Compile to es5

v3.0.4

Add missing built files in dist

v3.0.3

Migrate to babel, eslint, prettier and mocha

v3.0.2

Export window.PizZipUtils in utils generated bundle

v3.0.1

Update export to be able to do require("pizzip/utils");

v3.0.0

Initial release of Pizzip

v2.6.1 2016-07-28

  • update pako to v1.0.2 to fix a DEFLATE bug (see #322).

v2.6.0 2016-03-23

  • publish dist/ files in the npm package (see #225).
  • update pako to v1.0.0 (see #261).
  • add support of Array in PizZip#load (see #252).
  • improve file name / comment encoding support (see #211).
  • handle prepended data (see #266).
  • improve platform coverage in tests (see #233 and #269).

v2.5.0 2015-03-10

  • add support for custom mime-types (see #199).
  • add an option to set the DEFLATE level (see #201).
  • improve the error message with corrupted zip (see #202).
  • add support for UNIX / DOS permissions (see #200 and #205).

v2.4.0 2014-07-24

  • update pako to 0.2.5 (see #156).
  • make PizZip work in a Firefox addon context (see #151).
  • add an option (createFolders) to control the subfolder generation (see #154).
  • allow Buffer polyfill in the browser (see #139).

v2.3.0 2014-06-18

  • don't generate subfolders (see #130).
  • add comment support (see #134).
  • on ZipObject#options, the attributes date and dir have been deprecated and are now on ZipObject (see the upgrade guide).
  • on ZipObject#options, the attributes base64 and binary have been deprecated (see the upgrade guide).
  • deprecate internal functions exposed in the public API (see #123).
  • improve UTF-8 support (see #142).

v2.2.2, 2014-05-01

  • update pako to v0.2.1, fix an error when decompressing some files (see #126).

v2.2.1, 2014-04-23

  • fix unreadable generated file on Windows 8 (see #112).
  • replace zlibjs with pako.

v2.2.0, 2014-02-25

  • make the new operator optional before the PizZip constructor (see #93).
  • update zlibjs to v0.2.0.

v2.1.1, 2014-02-13

  • use the npm package for zlib.js instead of the github url.

v2.1.0, 2014-02-06

  • split the files and use Browserify to generate the final file (see #74)
  • packaging change : instead of 4 files (pizzip.js, pizzip-load.js, pizzip-inflate.js, pizzip-deflate.js) we now have 2 files : dist/pizzip.js and dist/pizzip.min.js
  • add component/bower support
  • rename variable: 'byte' is a reserved word (see #76)
  • add support for the unicode path extra field (see #82)
  • ensure that the generated files have a header with the licenses (see #80)

v2.0.0, 2013-10-20

  • PizZipBase64 has been renamed to PizZip.base64.

  • The data attribute on the object returned by zip.file(name) has been removed. Use asText(), asBinary(), asUint8Array(), asArrayBuffer() or asNodeBuffer().

  • Fix issue with Android browser

  • The compression/decompression methods now give their input type with the compressInputType and uncompressInputType attributes.

  • Lazily decompress data when needed and improve performance in general
  • Add support for Buffer in Node.js.
  • Package for CommonJS/npm.

v1.0.1, 2013-03-04

  • Fixed an issue when generating a compressed zip file with empty files or folders, see #33.
  • With bad data (null or undefined), asText/asBinary/asUint8Array/asArrayBuffer methods now return an empty string, see #36.

v1.0.0, 2013-02-14

  • First release after a long period without version.