1. module pdf-merge
   1. function pdf-merge (pdfFiles, pdftkPath)
   2. function pdf-merge.PdfMerge (pdfFiles, pdftkPath)
   3. object pdf-merge.PdfMerge.prototype
2. module pdf-merge.PdfMerge
   1. function pdf-merge.PdfMerge (pdfFiles, pdftkPath)
3. module pdf-merge.PdfMerge.prototype
   1. function pdf-merge.PdfMerge.prototype.asBuffer ()
   2. function pdf-merge.PdfMerge.prototype.asNewFile (path)
   3. function pdf-merge.PdfMerge.prototype.asReadStream ()
   4. function pdf-merge.PdfMerge.prototype.keepTmpFile ()
   5. function pdf-merge.PdfMerge.prototype.merge (callback)
   6. function pdf-merge.PdfMerge.prototype.promise ()

module pdf-merge

function pdf-merge (pdfFiles, pdftkPath)

• description and source-code

  function PDFMerge(pdfFiles, pdftkPath) {
  	if(!_(pdfFiles).isArray() || pdfFiles.length === 0) {
  		throw new Error('pdfFiles must be an array of absolute file paths.');
  	}
  
  	this.pdftkPath = pdftkPath;
  	if(pdftkPath && !fs.existsSync(pdftkPath)) {
  		throw new Error('Path to PDFtk is incorrect.');
  	}
  
  	//Windows: Demand path to lib
  	if(isWindowsPlatform()) {
  		this.isWin = true;
  	}
  
  	//Array of files
  	this.pdfFiles = pdfFiles;
  
  	//Get an available temporary filePath to be used in PDFtk
  	this.tmpFilePath = tmp.tmpNameSync();
  
  	//Setup Arguments to be used when calling PDFtk
  	this.execArgs = assembleExecArgs.call(this);
  
  	//Default Mode 'BUFFER';
  	this.mode = 'BUFFER';
  
  	//Default dont keep the temporary file
  	this.keepTmpFile = false;
  
  	return this;
  }

• example usage

  n/a

function pdf-merge.PdfMerge (pdfFiles, pdftkPath)

• description and source-code

  function PDFMerge(pdfFiles, pdftkPath) {
  	if(!_(pdfFiles).isArray() || pdfFiles.length === 0) {
  		throw new Error('pdfFiles must be an array of absolute file paths.');
  	}
  
  	this.pdftkPath = pdftkPath;
  	if(pdftkPath && !fs.existsSync(pdftkPath)) {
  		throw new Error('Path to PDFtk is incorrect.');
  	}
  
  	//Windows: Demand path to lib
  	if(isWindowsPlatform()) {
  		this.isWin = true;
  	}
  
  	//Array of files
  	this.pdfFiles = pdfFiles;
  
  	//Get an available temporary filePath to be used in PDFtk
  	this.tmpFilePath = tmp.tmpNameSync();
  
  	//Setup Arguments to be used when calling PDFtk
  	this.execArgs = assembleExecArgs.call(this);
  
  	//Default Mode 'BUFFER';
  	this.mode = 'BUFFER';
  
  	//Default dont keep the temporary file
  	this.keepTmpFile = false;
  
  	return this;
  }

• example usage

  n/a

module pdf-merge.PdfMerge

function pdf-merge.PdfMerge (pdfFiles, pdftkPath)

• description and source-code

  function PDFMerge(pdfFiles, pdftkPath) {
  	if(!_(pdfFiles).isArray() || pdfFiles.length === 0) {
  		throw new Error('pdfFiles must be an array of absolute file paths.');
  	}
  
  	this.pdftkPath = pdftkPath;
  	if(pdftkPath && !fs.existsSync(pdftkPath)) {
  		throw new Error('Path to PDFtk is incorrect.');
  	}
  
  	//Windows: Demand path to lib
  	if(isWindowsPlatform()) {
  		this.isWin = true;
  	}
  
  	//Array of files
  	this.pdfFiles = pdfFiles;
  
  	//Get an available temporary filePath to be used in PDFtk
  	this.tmpFilePath = tmp.tmpNameSync();
  
  	//Setup Arguments to be used when calling PDFtk
  	this.execArgs = assembleExecArgs.call(this);
  
  	//Default Mode 'BUFFER';
  	this.mode = 'BUFFER';
  
  	//Default dont keep the temporary file
  	this.keepTmpFile = false;
  
  	return this;
  }

• example usage

  n/a

module pdf-merge.PdfMerge.prototype

function pdf-merge.PdfMerge.prototype.asBuffer ()

• description and source-code

  asBuffer = function () {
  	this.mode = 'BUFFER';
  	return this;
  }

• example usage

  ...
  ```javascript
  var PDFMerge = require('pdf-merge');
  var pdftkPath = 'C:\\PDFtk\\bin\\pdftk.exe';
  var pdfFiles = [__dirname + '/pdf1.pdf', __dirname + '/pdf2.pdf'];
  var pdfMerge = new PDFMerge(pdfFiles, pdftkPath);
  
  pdfMerge
  .asBuffer()
  .merge(function(error, buffer) {
    //fs.writeFileSync(__dirname + '/merged.pdf', buffer);
  });
  
  ```
  ...

function pdf-merge.PdfMerge.prototype.asNewFile (path)

• description and source-code

  asNewFile = function (path) {
  	this.mode        = 'NEWFILE';
  	this.newFilePath = path;
  	return this;
  }

• example usage

  ...
  var pdfMerge = new PDFMerge([...]);
  pdfMerge.asReadStream().merge(function(error, readStream) {...});
  ```
  
  **asNewFile(`filePath`)** -- Store the output in a new file at the given filePath.
  ```
  var pdfMerge = new PDFMerge([...]);
  pdfMerge.asNewFile('merged.pdf').merge(function(error, filePath) {...});
  ```
  
  **keepTmpFile()** -- Keep the temporary file that is created when running PDFtk. For whatever reason..
  ```
  var pdfMerge = new PDFMerge([...]);
  pdfMerge.keepTmpFile().merge(function(error, buffer) {...});
  ```
  ...

function pdf-merge.PdfMerge.prototype.asReadStream ()

• description and source-code

  asReadStream = function () {
  	this.mode = 'READSTREAM';
  	return this;
  }

• example usage

  ...
  var pdfMerge = new PDFMerge([...]);
  pdfMerge.merge(function(error, result) {});
  ```
  
  **promise()** -- Promise style. Result is mixed, see the Chainable Options below. By default, a Buffer is always returned.
  ```
  var pdfMerge = new PDFMerge([...]);
  pdfMerge.asReadStream().promise()
  .then(function(readStream) {...})
  .catch(function(error) {...});
  ```
  
  ### API - Chainable Settings
  **asBuffer()** -- Result will be a Buffer of the merged PDF document.
  ```
  ...

function pdf-merge.PdfMerge.prototype.keepTmpFile ()

• description and source-code

  keepTmpFile = function () {
  	this.keepTmpFile = true;
  	return true;
  }

• example usage

  ...
  var pdfMerge = new PDFMerge([...]);
  pdfMerge.asNewFile('merged.pdf').merge(function(error, filePath) {...});
  ```
  
  **keepTmpFile()** -- Keep the temporary file that is created when running PDFtk. For whatever reason..
  ```
  var pdfMerge = new PDFMerge([...]);
  pdfMerge.keepTmpFile().merge(function(error, buffer) {...});
  ```
  ...

function pdf-merge.PdfMerge.prototype.merge (callback)

• description and source-code

  merge = function (callback) {
  	var mode        = this.mode;
  	var keepTmpFile = this.keepTmpFile; //Keep the Tmp File?
  	var tmpFilePath = this.tmpFilePath; //Filepath for PDF file being created by PDFtk
  	var newFilePath = this.newFilePath; //MODE === 'NEWFILE'
  
  	//Windows or not, different syntax
  	if(this.pdftkPath) {
  		child.execFile(this.pdftkPath, this.execArgs, execCallbackHandler)
  	} else {
  		child.exec('pdftk ' + this.execArgs.join(' '), execCallbackHandler);
  	}
  
  	/**
  	 * ErrorHandler for when PDFtk has been executed.
  	 * @param error
  	 * @returns {*}
  	 */
  	function execCallbackHandler(error) {
  		if(error) {
  			return callback(error);
  		}
  
  		/**
  		 * BUFFER/NEWFILE processed the same way.
  		 * For NEWFILE, it stores the buffer in a new file.
  		 */
  		if(mode === 'BUFFER' || mode === 'NEWFILE') {
  			fs.readFile(tmpFilePath, function(error, buffer) {
  				if(error) {
  					return callback(error);
  				}
  				deleteFile();
  
  				if(mode !== 'NEWFILE') {
  					return callback(null, buffer);
  				}
  
  				fs.writeFile(newFilePath, buffer, function(error) {
  					return callback(error, newFilePath);
  				})
  			});
  		} else if(mode === 'READSTREAM') {
  			var readStream = fs.createReadStream(tmpFilePath);
  			callback(null, readStream);
  			readStream.on('end', function() {
  				deleteFile();
  			});
  		}
  	}
  
  	/**
  	 * Cleanup the temporary file created through PDFtk.
  	 * Don't cleanup if keepTmpFile === true
  	 */
  	function deleteFile() {
  		if(!keepTmpFile) {
  			fs.unlink(tmpFilePath, function() {});
  		}
  	}
  }

• example usage

  ...
  var PDFMerge = require('pdf-merge');
  var pdftkPath = 'C:\\PDFtk\\bin\\pdftk.exe';
  var pdfFiles = [__dirname + '/pdf1.pdf', __dirname + '/pdf2.pdf'];
  var pdfMerge = new PDFMerge(pdfFiles, pdftkPath);
  
  pdfMerge
  .asBuffer()
  .merge(function(error, buffer) {
    //fs.writeFileSync(__dirname + '/merged.pdf', buffer);
  });
  
  ```
  
  
  ### Usage
  ...

function pdf-merge.PdfMerge.prototype.promise ()

• description and source-code

  promise = function () {
  	var def = Q.defer();
  
  	this.merge(function(error, result) {
  		if(error) {
  			return def.reject(error);
  		}
  
  		def.resolve(result);
  	});
  
  	return def.promise;
  }

• example usage

  ...
  
  //Callback-style
  pdfMerge.merge(function(error, result) {
  //Handle your error / result here
  });
  
  //Promise-style
  pdfMerge.promise().then(function(result) {
  //Handle result
  }).catch(function(error) {
  //Handle error
  });
  ```
  
  ### API - Main
  ...