# node-zipkit

> Corss platform compress or extract `zip` archive

Latest version **0.1.2** (published 2016-07-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install node-zipkit
pnpm add node-zipkit
yarn add node-zipkit
bun add node-zipkit
```

## 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.2 |
| Published | 2016-07-19 |
| First published | 2016-07-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | huang.xinghui |
| Maintainers | huang.xinghui |
| Keywords | zip, node |

## Links

- npm: https://www.npmjs.com/package/node-zipkit
- Repository: https://github.com/huang-x-h/node-zipkit
- Homepage: https://github.com/huang-x-h/node-zipkit#readme
- Issues: https://github.com/huang-x-h/node-zipkit/issues
- npm.io page: https://npm.io/package/node-zipkit

## Dependencies (1)

- [rimraf](https://npm.io/package/rimraf.md) ^2.5.3

## 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.2 (latest) — 2016-07-19
- 0.1.1 — 2016-07-17
- 0.1.0 — 2016-07-14

## README

# node-zipkit

> Corss platform compress or extract `zip` archive, inspired by [feross/cross-zip](https://github.com/feross/cross-zip)

## Install

**Node.js 4 or higher**

    $ npm install node-zipkit --save

## Usage

```js
// zip folder
const path = require('path');
const zipkit = require('node-zipkit');

zipkit.zip(path.join(__dirname, 'test.zip'), path.join(__dirname, 'test.js')).then(function(directoryPath) {
  console.log('compress', directoryPath, 'success.');
});

// unzip archive
zipkit.unzip(path.join(__dirname, 'test.zip'), path.join(__dirname, 'test')).then(function(directoryPath) {
  console.log('extract', directoryPath, 'success.');
});
```

## API

- zipkit.zip(archivePath, filePath)

  Add files to archive

- zipkit.zipSync(archivePath, filePath)

  Synchronous version of `zip`

- zipkit.unzip(archivePath, filePath)

  Extract files from archive

- zipkit.unzipSync(archivePath, filePath)

  Synchronous version of `unzip`

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