# zipfile-diff

> caculate diff between two zip files

Latest version **1.0.1** (published 2018-01-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install zipfile-diff
pnpm add zipfile-diff
yarn add zipfile-diff
bun add zipfile-diff
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2018-01-27 |
| First published | 2017-12-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | 593233820@qq.com |
| Maintainers | mystorpx |
| Keywords | zip, diff |

## Links

- npm: https://www.npmjs.com/package/zipfile-diff
- Repository: https://github.com/mystorp/node-zipfile-diff
- Issues: https://github.com/mystorp/node-zipfile-diff/issues
- npm.io page: https://npm.io/package/zipfile-diff

## Dependencies (2)

- [yazl](https://npm.io/package/yazl.md) ^2.4.3
- [yauzl](https://npm.io/package/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

- 1.0.1 (latest) — 2018-01-27
- 1.0.0 — 2017-12-25

## README

# node-zipfile-diff
一个用于计算两个压缩包差异的简单库。

> 当软件包有更新时，根据这个库计算差异量，并只下载有差异的部分，节省流量。

## install
```bash
npm install zipfile-diff
```

## API

### `entryDiff(file1, file2)`
`Promise<Array<String>>`. 比较两个压缩包，成功时返回变更的 entry 数组。如：
```js
var differ = require("zipfile-diff");

differ.entryDiff("./v1.zip", "./v2.zip").then(function(entries){
    console.log(entries);
    // output: [ "test/1.txt", "test/test/2.txt"]
});
```

### `diff2zip(file1, file2)`
`Promise<Stream>`. 比较两个压缩包，成功时返回 zip 输出流。如：
```js
var differ = require("zipfile-diff");
differ.diff2zip("./v1.zip", "./v2.zip").then(function(stream){
    stream.pipe(fs.createReadStream("test.zip"));
});
```

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