# folder-zip-sync

> zip a folder synchronously

Latest version **1.0.5** (published 2018-01-28) · MIT license · 0 weekly downloads

## Install

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

Provides the command `folder-zip-sync`.

## 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.5 |
| Published | 2018-01-28 |
| First published | 2017-01-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | kareniel |
| Maintainers | kareniel |
| Keywords | aws |

## Links

- npm: https://www.npmjs.com/package/folder-zip-sync
- npm.io page: https://npm.io/package/folder-zip-sync

## Dependencies (2)

- [yazl](https://npm.io/package/yazl.md) ^2.4.2
- [deasync](https://npm.io/package/deasync.md) ^0.1.9

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 1.0.5 (latest) — 2018-01-28
- 1.0.4 — 2017-01-24
- 1.0.3 — 2017-01-24
- 1.0.2 — 2017-01-20
- 1.0.1 — 2017-01-20
- 1.0.0 — 2017-01-20

## README

# folder-zip-sync

zip a folder synchronously.

## as a function

```bash
npm install --save folder-zip-sync
```

```js
const zipFolder = require('folder-zip-sync')

zipFolder('./myFolder', 'myZipFile.zip', ['privateFile.txt'])
// Done!
```


## as a command line

```bash
Install:
  npm install -g folder-zip-sync

Usage:
  folder-zip-sync [source] [output] [ignored]

Arguments:
    source: The folder you want to zip
    output: Optional. Name of the file created. Defaults to output.zip
    ignored: Optional. List of files you want to exclude. Defaults to .git
```

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