replace error emitting on methods with callback.

CHANGELOG

@@ -1,6 +1,8 @@
 v0.3.0:
   date: 2013-01-30
   changes:
+    - (in development)
+    - replace error emitting on methods with callback.
     - add generic create method.
     - make tar recordSize configurable for advanced users.
 v0.2.2:

README.md

@@ -16,11 +16,11 @@ You can also use `npm install https://github.com/ctalkington/node-archiver/archi
 
 Creates an Archiver instance based on the type (ie zip/tar) passed.
 
-#### addFile(inputStream, data, callback)
+#### addFile(inputStream, data, callback(err))
 
 Adds a file to the Archiver stream.
 
-#### finalize(callback(written))
+#### finalize(callback(err, written))
 
 Finalizes the Archiver stream. When everything is done, callback is called with the total number of bytes in the archive.
 

examples/pack-async.js

@@ -6,19 +6,26 @@ var async = require('async');
 var out = fs.createWriteStream('out.zip');
 var archive = archiver.createZip();
 
-archive.pipe(out);
-
 archive.on('error', function(err) {
   console.log(err);
-  // then handle exit process or such
 });
 
+archive.pipe(out);
+
 async.forEachSeries(['file1.js', 'file2.js'], function(file, next) {
-  archive.addFile(fs.createReadStream(file), { name: file }, function() {
-    next();
+  archive.addFile(fs.createReadStream(file), { name: file }, function(err) {
+    next(err);
   });
 }, function(err) {
-  archive.finalize(function(written) {
+  if (err) {
+    throw err;
+  }
+
+  archive.finalize(function(err, written) {
+    if (err) {
+      throw err;
+    }
+
     console.log(written + ' total bytes written');
   });
 });

examples/pack-tar-gzip.js

@@ -7,11 +7,27 @@ var out = fs.createWriteStream('out.tar.gz');
 var gzipper = zlib.createGzip();
 var archive = archiver.createTar();
 
+archive.on('error', function(err) {
+  console.log(err);
+});
+
 archive.pipe(gzipper).pipe(out);
 
-archive.addFile(fs.createReadStream('file1.js'), {name: 'file1.js'}, function() {
-  archive.addFile(fs.createReadStream('file2.js'), {name: 'file2.js'}, function() {
-    archive.finalize(function(written) {
+archive.addFile(fs.createReadStream('file1.js'), {name: 'file1.js'}, function(err) {
+  if (err) {
+    throw err;
+  }
+
+  archive.addFile(fs.createReadStream('file2.js'), {name: 'file2.js'}, function(err) {
+    if (err) {
+      throw err;
+    }
+
+    archive.finalize(function(err, written) {
+      if (err) {
+        throw err;
+      }
+
       console.log(written + ' total bytes written'); // this wont be accurate since gzip happens after tar
     });
   });

examples/pack.js

@@ -5,11 +5,27 @@ var archiver = require('archiver');
 var out = fs.createWriteStream('out.zip'); // or out.tar
 var archive = archiver.createZip(); // or createTar
 
+archive.on('error', function(err) {
+  console.log(err);
+});
+
 archive.pipe(out);
 
-archive.addFile(fs.createReadStream('file1.js'), {name: 'file1.js'}, function() {
-  archive.addFile(fs.createReadStream('file2.js'), {name: 'file2.js'}, function() {
-    archive.finalize(function(written) {
+archive.addFile(fs.createReadStream('file1.js'), {name: 'file1.js'}, function(err) {
+  if (err) {
+    throw err;
+  }
+
+  archive.addFile(fs.createReadStream('file2.js'), {name: 'file2.js'}, function(err) {
+    if (err) {
+      throw err;
+    }
+
+    archive.finalize(function(err, written) {
+      if (err) {
+        throw err;
+      }
+
       console.log(written + ' total bytes written');
     });
   });

lib/archiver/core.js

@@ -52,7 +52,7 @@ Archiver.prototype._read = function() {
     self.readable = false;
 
     if (utils.lo.isFunction(self.callback)) {
-      self.callback(self.fileptr);
+      self.callback(null, self.fileptr);
     }
   }
 

lib/archiver/tar.js

@@ -127,8 +127,12 @@ tarArchiver.prototype._writeData = function(file, sourceBuffer) {
 tarArchiver.prototype.addFile = function(source, data, callback) {
   var self = this;
 
+  if (utils.lo.isFunction(callback) === false) {
+    callback = utils.fallCall;
+  }
+
   if (self.busy) {
-    self.emit('error', 'previous file not finished');
+    callback(new Error('Previous file not finished'));
     return;
   }
 
@@ -147,7 +151,7 @@ tarArchiver.prototype.addFile = function(source, data, callback) {
   });
 
   if (utils.lo.isEmpty(file.name) || utils.lo.isString(file.name) === false) {
-    self.emit('error', 'name must be a valid string value');
+    callback(new Error('Name must be a valid string value'));
     return;
   }
 
@@ -215,8 +219,12 @@ tarArchiver.prototype.addFile = function(source, data, callback) {
 tarArchiver.prototype.finalize = function(callback) {
   var self = this;
 
+  if (utils.lo.isFunction(callback) === false) {
+    callback = utils.fallCall;
+  }
+
   if (self.files.length === 0) {
-    self.emit('error', 'no files in tar');
+    callback(new Error('No files in archive'));
     return;
   }
 

lib/archiver/zip.js

@@ -266,8 +266,12 @@ zipArchiver.prototype._pushCentralDirectory = function() {
 zipArchiver.prototype.addFile = function(source, data, callback) {
   var self = this;
 
+  if (utils.lo.isFunction(callback) === false) {
+    callback = utils.fallCall;
+  }
+
   if (self.busy) {
-    self.emit('error', 'previous file not finished');
+    callback(new Error('Previous file not finished'));
     return;
   }
 
@@ -285,7 +289,7 @@ zipArchiver.prototype.addFile = function(source, data, callback) {
   });
 
   if (utils.lo.isEmpty(file.name) || utils.lo.isString(file.name) === false) {
-    self.emit('error', 'name must be a valid string value');
+    callback(new Error('Name must be a valid string value'));
     return;
   }
 
@@ -388,8 +392,12 @@ zipArchiver.prototype.addFile = function(source, data, callback) {
 zipArchiver.prototype.finalize = function(callback) {
   var self = this;
 
+  if (utils.lo.isFunction(callback) === false) {
+    callback = utils.fallCall;
+  }
+
   if (self.files.length === 0) {
-    self.emit('error', 'no files in zip');
+    callback(new Error('No files in archive'));
     return;
   }
 

lib/util/utils.js

@@ -113,4 +113,12 @@ utils.unixifyPath = function(filepath) {
   } else {
     return filepath;
   }
+};
+
+utils.fallCall = function(err, data) {
+  if (err) {
+    throw err;
+  }
+
+  return data;
 };