28 lines
905 B
Markdown
28 lines
905 B
Markdown
|
# Archiver v1.1.0
|
||
|
|
|
||
|
|
[](https://travis-ci.org/archiverjs/node-archiver) [](https://ci.appveyor.com/project/ctalkington/node-archiver/branch/master)
|
||
|
|
|
||
|
|
a streaming interface for archive generation
|
||
|
|
|
||
|
|
Visit the [API documentation](http://archiverjs.com/docs) for a list of all methods available.
|
||
|
|
|
||
|
|
## Install
|
||
|
|
|
||
|
|
```bash
|
||
|
|
npm install archiver --save
|
||
|
|
```
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```js
|
||
|
|
var archiver = require('archiver');
|
||
|
|
var archive = archiver.create('zip', {}); // or archiver('zip', {});
|
||
|
|
```
|
||
|
|
|
||
|
|
## Formats
|
||
|
|
|
||
|
|
Archiver ships with out of the box support for TAR and ZIP archives.
|
||
|
|
|
||
|
|
You can register additional formats with `registerFormat`.
|
||
|
|
|
||
|
|
_Formats will be changing in the next few releases to implement a middleware approach._
|