diff options
Diffstat (limited to 'node_modules/archiver/README.md')
| -rw-r--r-- | node_modules/archiver/README.md | 50 |
1 files changed, 47 insertions, 3 deletions
diff --git a/node_modules/archiver/README.md b/node_modules/archiver/README.md index 0eaa2b725..654d7db34 100644 --- a/node_modules/archiver/README.md +++ b/node_modules/archiver/README.md @@ -1,4 +1,4 @@ -# Archiver v1.2.0
+# Archiver v1.3.0
[](https://travis-ci.org/archiverjs/node-archiver) [](https://ci.appveyor.com/project/ctalkington/node-archiver/branch/master)
@@ -12,11 +12,55 @@ Visit the [API documentation](http://archiverjs.com/docs) for a list of all meth npm install archiver --save
```
-## Usage
+## Quick Start
```js
+// require modules
+var fs = require('fs');
var archiver = require('archiver');
-var archive = archiver.create('zip', {}); // or archiver('zip', {});
+
+// create a file to stream archive data to.
+var output = fs.createWriteStream(__dirname + '/example.zip');
+var archive = archiver('zip', {
+ store: true // Sets the compression method to STORE.
+});
+
+// listen for all archive data to be written
+output.on('close', function() {
+ console.log(archive.pointer() + ' total bytes');
+ console.log('archiver has been finalized and the output file descriptor has closed.');
+});
+
+// good practice to catch this error explicitly
+archive.on('error', function(err) {
+ throw err;
+});
+
+// pipe archive data to the file
+archive.pipe(output);
+
+// 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 (ie we are done appending files but streams have to finish yet)
+archive.finalize();
```
## Formats
|