Skip to content

gordonmleigh/unzip-iterable

Repository files navigation

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

About

Thin wrapper around yauzl

Resources

License

Stars

Watchers

Forks

Packages

No packages published