blob: f90c938d40463f152a4310ad4007fab724009a93 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
|
# Archiver v1.1.0
[![Build Status](https://travis-ci.org/archiverjs/node-archiver.svg?branch=master)](https://travis-ci.org/archiverjs/node-archiver) [![Build status](https://ci.appveyor.com/api/projects/status/38kqu3yp159nodxe/branch/master?svg=true)](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._
|