unzippo is a thin wrapper around node-stream-zip that does all the actual job. The only thing the present module provides is a procedural API for atomic operations.

Atomic here means a zip file is opened, its central directory is read and then the resources are disposed for each separate call. In most cases, this cause no significant overhead but allows to write simpler, cleaner code.

Since the async API is implemented by the original node-stream-zip, there is little sense left to wrap it any more.

Still, one may prefer to use one liners instead of coping with the mandatory asynchronous .close().

Installation

npm install unzippo

Basic usage

const zip = require ('unzippo')

const entries = await zip.list ('/some/archive.zip')

(await zip.open ('/some/archive.zip', 'logs/access.log')).pipe (process.stdout)

const txt   = await zip.read ('/some/archive.zip', 'README.txt')
const wenzi = await zip.read ('/some/archive.zip', 'README.txt.zh', 'ucs2')

const buf   = await zip.get  ('/some/archive.zip', 'images/0.gif')

Listing the archive content

const entries = await zip.list (zipFileName)

returns exactly the same data structure as node-stream-zip's zip.entries():

{
  '/path/to/someEntry': {
    name: '/path/to/someEntry', // same as the key
    size: 354354,               // uncompressed, bytes
    ...,                        // technical info
  },
  ...                           // other entries
}

Extracting a file as a stream

const in = await zip.open (zipFileName, entryPath) // .pipe (myXform)...

returns the binary readable stream corresponding to entryPath inside zipFileName.

This is the preferred, recommended way to read files from zip archives as it causes no memory related risk.

Reading a whole file

For a small file, it may be acceptable to read it at once, in form of Buffer:

const buf = await zip.get (zipFileName, entryPath)

In most cases, such files have text content, so it's handier to have it as a String:

const txt = await zip.read (zipFileName, entryPath) // utf8
const txt = await zip.read (zipFileName, entryPath, encoding)