# zip-folder

> zips a folder and calls your callback when it's done

Latest version **1.0.0** (published 2014-10-22) · Apache 2 license · 0 weekly downloads

## Install

```sh
npm install zip-folder
pnpm add zip-folder
yarn add zip-folder
bun add zip-folder
```

## 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.0 |
| Published | 2014-10-22 |
| First published | 2014-10-22 |
| Weekly downloads | 0 |
| License | Apache 2 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 44 |
| Author | sole |
| Maintainers | sole |
| Keywords | zip, folder |

## Links

- npm: https://www.npmjs.com/package/zip-folder
- Repository: https://github.com/sole/node-zip-folder
- Issues: https://github.com/sole/node-zip-folder/issues
- npm.io page: https://npm.io/package/zip-folder

## Dependencies (1)

- [archiver](https://npm.io/package/archiver.md) ^0.11.0

## 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.0 (latest) — 2014-10-22

## README

# node-zip-folder

> zips a folder and calls your callback when it's done
> AKA: something that maybe already exists in npmjs.org, but that I couldn't find.

## Usage

```javascript
var zipFolder = require('zip-folder');

zipFolder('/path/to/the/folder', '/path/to/archive.zip', function(err) {
	if(err) {
		console.log('oh no!', err);
	} else {
		console.log('EXCELLENT');
	}
});
```

## Tests

Tests are in `tests.js` and built with nodeunit. Run `npm test` to run the tests.

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