# unzip-iterable

> Thin wrapper around yauzl

Latest version **0.1.3** (published 2020-06-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install unzip-iterable
pnpm add unzip-iterable
yarn add unzip-iterable
bun add unzip-iterable
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.3 |
| Published | 2020-06-05 |
| First published | 2020-06-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 12.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Gordon Leigh |
| Maintainers | gordonmleigh |
| Keywords | zip, archive, unzip, async, iterable, file |

## Links

- npm: https://www.npmjs.com/package/unzip-iterable
- Repository: https://github.com/gordonmleigh/unzip-iterable
- Homepage: https://github.com/gordonmleigh/unzip-iterable#readme
- Issues: https://github.com/gordonmleigh/unzip-iterable/issues
- npm.io page: https://npm.io/package/unzip-iterable

## Dependencies (2)

- [yauzl](https://npm.io/package/yauzl.md) ^2.10.0
- [@types/yauzl](https://npm.io/package/@types/yauzl.md) ^2.9.1

## Alternatives

- [lodash.startswith](https://npm.io/package/lodash.startswith.md) — 769.7K weekly downloads
- [@tarojs/service](https://npm.io/package/@tarojs/service.md) — 33.9K weekly downloads
- [io.extendreality.tilia.indicators.spatialtargets.unity](https://npm.io/package/io.extendreality.tilia.indicators.spatialtargets.unity.md) — 131 weekly downloads
- [@rtarojs/taro](https://npm.io/package/@rtarojs/taro.md) — 90 weekly downloads
- [node-branch-io](https://npm.io/package/node-branch-io.md) — 50 weekly downloads

## Recent versions

- 0.1.3 (latest) — 2020-06-05
- 0.1.2 — 2020-06-05
- 0.1.1 — 2020-06-05
- 0.1.0 — 2020-06-05

## README

# unzip-iterable

Thin wrapper around [yauzl](https://github.com/thejoshwolfe/yauzl).

## openZip()

```typescript
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.

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

### info

Get info about the zip entry. See the
[yazl docs](https://github.com/thejoshwolfe/yauzl#class-entry) 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.

```typescript
class ZipEntryStream extends stream.Readable
```

---
_Source: https://npm.io/package/unzip-iterable · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._