# fly-zip

> ZIP compress files with Fly

Latest version **2.1.0** (published 2017-02-01) · MIT license · 0 weekly downloads

## Install

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

## 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 | 2.1.0 |
| Published | 2017-02-01 |
| First published | 2016-04-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 6 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Luke Edwards |
| Maintainers | lukeed |
| Keywords | fly, fly-plugin, zip, archive, archiver, compress, compression |

## Links

- npm: https://www.npmjs.com/package/fly-zip
- Repository: https://github.com/lukeed/fly-zip
- Homepage: https://github.com/lukeed/fly-zip#readme
- Issues: https://github.com/lukeed/fly-zip/issues
- npm.io page: https://npm.io/package/fly-zip

## Dependencies (1)

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

- 2.1.0 (latest) — 2017-02-01
- 2.0.0 — 2016-10-20
- 1.0.0 — 2016-04-06
- 0.0.0 — 2016-04-06

## README

# fly-zip [![][travis-badge]][travis-link] [![npm package][npm-ver-link]][npm-pkg-link]

> ZIP compress files with Fly.

## Install

```
npm install --save-dev fly-zip
```

## Usage

This will produces a ZIP at `releases/Archive.zip`, containing all contents within the `dist` directory.

```js
exports.zip = function * (fly) {
  yield fly.source('dist/**/*').zip({
    dest: 'releases',
    file: 'Archive.zip'
  });
};
```

## API

### .zip(options)

#### options.dest

Type: `string`<br>
Default: `'.'`

The directory where the ZIP should be placed. Defaults to Fly's root directory, where `flyfile.js` is located.

#### options.file

Type: `string`<br>
Default: `'archive.zip'`

The name of your ZIP file. It must include `.zip`.

## License

MIT © [Luke Edwards](https://lukeed.com)


[npm-pkg-link]: https://www.npmjs.org/package/fly-zip
[npm-ver-link]: https://img.shields.io/npm/v/fly-zip.svg?style=flat-square
[travis-link]:  https://travis-ci.org/lukeed/fly-zip
[travis-badge]: http://img.shields.io/travis/lukeed/fly-zip.svg?style=flat-square

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