# archiver-promise

> Promise wrapper for archiver

Latest version **1.0.0** (published 2016-11-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install archiver-promise
pnpm add archiver-promise
yarn add archiver-promise
bun add archiver-promise
```

## 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 | 2016-11-24 |
| First published | 2016-11-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Liang |
| Maintainers | liangxingchen |
| Keywords | archiver, zip, tar, promise, async |

## Links

- npm: https://www.npmjs.com/package/archiver-promise
- Repository: https://github.com/maichong/archiver-promise
- Homepage: https://github.com/maichong/archiver-promise#readme
- Issues: https://github.com/maichong/archiver-promise/issues
- npm.io page: https://npm.io/package/archiver-promise

## Dependencies (1)

- [archiver](https://npm.io/package/archiver.md) ^1.2.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) — 2016-11-24

## README

# archiver-promise

Promise wrapper for archiver

```js

var archiver = require('archiver-promise');

var archive = archiver('path/to/file.zip',{
  store: true
  // more options https://archiverjs.com/docs/
});

// append a file from stream
var file1 = __dirname + '/file1.txt';
archive.append(fs.createReadStream(file1), { name: 'file1.txt' });

// append a file from string
archive.append('string cheese!', { name: 'file2.txt' });

// append a file from buffer
var buffer3 = new Buffer('buff it!');
archive.append(buffer3, { name: 'file3.txt' });

// append a file
archive.file('file1.txt', { name: 'file4.txt' });

// append files from a directory
archive.directory('subdir/');

// append files from a glob pattern
archive.glob('subdir/*.txt');

// finalize the archive
archive.finalize().then(function(){
  console.log('done');
});

```

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