# @xmcl/unzip

> A easy unzip interface based on yauzl

Latest version **2.2.0** (published 2026-07-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install @xmcl/unzip
pnpm add @xmcl/unzip
yarn add @xmcl/unzip
bun add @xmcl/unzip
```

## Health

**Score 60/100 (C)** — status: active.

Positive: no vulnerabilities; has provenance; recently updated; high maintenance score.

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

## Facts

| | |
|---|---|
| Version | 2.2.0 |
| Published | 2026-07-25 |
| First published | 2019-07-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=20 |
| Dependencies | 1 |
| Unpacked size | 41.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 1598 |
| Author | cijhn@hotmail.com |
| Maintainers | ci010 |
| Keywords | typescript, nodejs, yauzl, unzip, zlib, extract |

## Links

- npm: https://www.npmjs.com/package/@xmcl/unzip
- Repository: https://github.com/Voxelum/x-minecraft-launcher
- Homepage: https://github.com/Voxelum/minecraft-launcher-core-node#readme
- Issues: https://github.com/Voxelum/minecraft-launcher-core-node/issues
- npm.io page: https://npm.io/package/@xmcl/unzip

## Dependencies (1)

- [@xmcl/yauzl](https://npm.io/package/@xmcl/yauzl.md) workspace:^*

## 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

- 2.2.0 (latest) — 2026-07-25
- 2.1.2 — 2023-04-24
- 2.1.1 — 2023-04-16
- 2.1.0 — 2023-04-13
- 2.0.0 — 2020-12-20
- 1.2.0 — 2020-04-10
- 1.1.3 — 2020-03-15
- 1.1.2 — 2020-03-14
- 1.1.1 — 2020-03-07
- 1.1.0 — 2020-03-04
- 1.0.5-alpha.1 — 2020-02-10
- 1.0.5-alpha.0 — 2020-01-23
- 1.0.4 — 2020-01-22
- 1.0.3 — 2019-11-26
- 1.0.2 — 2019-11-25
- … 10 more at https://npm.io/package/@xmcl/unzip/versions

## README

# Unzip Module

[![npm version](https://img.shields.io/npm/v/@xmcl/unzip.svg)](https://www.npmjs.com/package/@xmcl/unzip)
[![Downloads](https://img.shields.io/npm/dm/@xmcl/unzip.svg)](https://npmjs.com/@xmcl/unzip)
[![Install size](https://packagephobia.now.sh/badge?p=@xmcl/unzip)](https://packagephobia.now.sh/result?p=@xmcl/unzip)
[![npm](https://img.shields.io/npm/l/@xmcl/minecraft-launcher-core.svg)](https://github.com/voxelum/minecraft-launcher-core-node/blob/master/LICENSE)
[![Build Status](https://github.com/voxelum/minecraft-launcher-core-node/workflows/Build/badge.svg)](https://github.com/Voxelum/minecraft-launcher-core-node/actions?query=workflow%3ABuild)

A simple Unzipper wrapper for yauzl in nodejs.

Support `Promise` and nodejs `Stream`.

## Who might care this package

The people

1. who use nodejs
2. who want a unzip only interface
3. who think yauzl is good but its API is hard to use

might want to look at this.

## Where is the document

Since this is majorly used in its [parent project](https://github.com/voxelum/minecraft-launcher-core-node). You can

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