https://github.com/do-/unzippo
One-liner approach to safely read streams from zip files
https://github.com/do-/unzippo
Last synced: about 1 month ago
JSON representation
One-liner approach to safely read streams from zip files
- Host: GitHub
- URL: https://github.com/do-/unzippo
- Owner: do-
- License: mit
- Created: 2020-03-11T08:13:07.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2025-02-15T09:25:54.000Z (about 1 year ago)
- Last Synced: 2025-09-25T17:50:18.768Z (6 months ago)
- Language: JavaScript
- Size: 563 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
`unzippo` is a thin wrapper around [`node-stream-zip`](https://www.npmjs.com/package/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](https://www.npmjs.com/package/node-stream-zip#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](https://www.npmjs.com/package/node-stream-zip#async-api:~:text=//%20Do%20not%20forget%20to%20close%20the%20file%20once%20you%27re%20done%0Aawait%20zip.close()%3B) asynchronous `.close()`.
## Installation
```
npm install unzippo
```
## Basic usage
```js
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
```js
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
```js
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`:
```js
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`:
```js
const txt = await zip.read (zipFileName, entryPath) // utf8
const txt = await zip.read (zipFileName, entryPath, encoding)
```