npm.io
0.1.3 • Published 6 years ago

unzip-iterable

Licence
MIT
Version
0.1.3
Deps
2
Size
13 kB
Vulns
0
Weekly
0

unzip-iterable

Thin wrapper around yauzl.

openZip()

function openZip(zipPath: string): AsyncIterable<ZipEntry>;

Opens a zip file as an async iterable of zip entries.

ZipEntry

Represents an entry in a zip file.

interface ZipEntry {
  info: yauzl.Entry;
  open(): PromiseLike<stream.Readable>;
}
info

Get info about the zip entry. See the yazl docs for more info.

open()

Get a readable stream for the contents of the entry.

ZipEntryStream

Implements an object-mode readable stream which will read all of the entries in a zip file.

class ZipEntryStream extends stream.Readable

Keywords