1. module pdf-image
   1. function pdf-image.PDFImage (pdfFilePath, options)
   2. object pdf-image.PDFImage.prototype
2. module pdf-image.PDFImage
   1. function pdf-image.PDFImage (pdfFilePath, options)
3. module pdf-image.PDFImage.prototype
   1. function pdf-image.PDFImage.prototype.constructConvertCommandForPage (pageNumber)
   2. function pdf-image.PDFImage.prototype.constructConvertOptions ()
   3. function pdf-image.PDFImage.prototype.constructGetInfoCommand ()
   4. function pdf-image.PDFImage.prototype.convertPage (pageNumber)
   5. function pdf-image.PDFImage.prototype.getInfo ()
   6. function pdf-image.PDFImage.prototype.getOutputImagePathForPage (pageNumber)
   7. function pdf-image.PDFImage.prototype.numberOfPages ()
   8. function pdf-image.PDFImage.prototype.parseGetInfoCommandOutput (output)
   9. function pdf-image.PDFImage.prototype.setConvertExtension (convertExtension)
   10. function pdf-image.PDFImage.prototype.setConvertOptions (convertOptions)

module pdf-image

function pdf-image.PDFImage (pdfFilePath, options)

• description and source-code

  function PDFImage(pdfFilePath, options) {
    if (!options) options = {};
  
    this.pdfFilePath = pdfFilePath;
    this.pdfFileBaseName = path.basename(pdfFilePath, ".pdf");
  
    this.setConvertOptions(options.convertOptions);
    this.setConvertExtension(options.convertExtension);
    this.useGM = options.graphicsMagick || false;
  
    this.outputDirectory = options.outputDirectory || path.dirname(pdfFilePath);
  }

• example usage

  n/a

module pdf-image.PDFImage

function pdf-image.PDFImage (pdfFilePath, options)

• description and source-code

  function PDFImage(pdfFilePath, options) {
    if (!options) options = {};
  
    this.pdfFilePath = pdfFilePath;
    this.pdfFileBaseName = path.basename(pdfFilePath, ".pdf");
  
    this.setConvertOptions(options.convertOptions);
    this.setConvertExtension(options.convertExtension);
    this.useGM = options.graphicsMagick || false;
  
    this.outputDirectory = options.outputDirectory || path.dirname(pdfFilePath);
  }

• example usage

  n/a

module pdf-image.PDFImage.prototype

function pdf-image.PDFImage.prototype.constructConvertCommandForPage (pageNumber)

• description and source-code

  constructConvertCommandForPage = function (pageNumber) {
    var pdfFilePath = this.pdfFilePath;
    var outputImagePath = this.getOutputImagePathForPage(pageNumber);
    var convertOptionsString = this.constructConvertOptions();
    return util.format(
      "%s %s'%s[%d]' '%s'",
      this.useGM ? "gm convert" : "convert",
      convertOptionsString ? convertOptionsString + " " : "",
      pdfFilePath, pageNumber, outputImagePath
    );
  }

• example usage

  ...
      return optionName;
    }
  }, this).join(" ");
    },
    convertPage: function (pageNumber) {
  var pdfFilePath     = this.pdfFilePath;
  var outputImagePath = this.getOutputImagePathForPage(pageNumber);
  var convertCommand  = this.constructConvertCommandForPage(pageNumber);
  
  var promise = new Promise(function (resolve, reject) {
    function convertPageToImage() {
      exec(convertCommand, function (err, stdout, stderr) {
        if (err) {
          return reject({
            message: "Failed to convert page to image",
  ...

function pdf-image.PDFImage.prototype.constructConvertOptions ()

• description and source-code

  constructConvertOptions = function () {
    return Object.keys(this.convertOptions).sort().map(function (optionName) {
      if (this.convertOptions[optionName] !== null) {
        return optionName + " " + this.convertOptions[optionName];
      } else {
        return optionName;
      }
    }, this).join(" ");
  }

• example usage

  ...
  },
  setConvertExtension: function (convertExtension) {
    this.convertExtension = convertExtension || "png";
  },
  constructConvertCommandForPage: function (pageNumber) {
    var pdfFilePath = this.pdfFilePath;
    var outputImagePath = this.getOutputImagePathForPage(pageNumber);
    var convertOptionsString = this.constructConvertOptions();
    return util.format(
      "%s %s'%s[%d]' '%s'",
      this.useGM ? "gm convert" : "convert",
      convertOptionsString ? convertOptionsString + " " : "",
      pdfFilePath, pageNumber, outputImagePath
    );
  },
  ...

function pdf-image.PDFImage.prototype.constructGetInfoCommand ()

• description and source-code

  constructGetInfoCommand = function () {
    return util.format(
      "pdfinfo '%s'",
      this.pdfFilePath
    );
  }

• example usage

  ...
        info[RegExp.$1] = RegExp.$2;
      }
    });
    return info;
  },
  getInfo: function () {
    var self = this;
    var getInfoCommand = this.constructGetInfoCommand();
    var promise = new Promise(function (resolve, reject) {
      exec(getInfoCommand, function (err, stdout, stderr) {
        if (err) {
          return reject({
            message: "Failed to get PDF'S information",
            error: err,
            stdout: stdout,
  ...

function pdf-image.PDFImage.prototype.convertPage (pageNumber)

• description and source-code

  convertPage = function (pageNumber) {
    var pdfFilePath     = this.pdfFilePath;
    var outputImagePath = this.getOutputImagePathForPage(pageNumber);
    var convertCommand  = this.constructConvertCommandForPage(pageNumber);
  
    var promise = new Promise(function (resolve, reject) {
      function convertPageToImage() {
        exec(convertCommand, function (err, stdout, stderr) {
          if (err) {
            return reject({
              message: "Failed to convert page to image",
              error: err,
              stdout: stdout,
              stderr: stderr
            });
          }
          return resolve(outputImagePath);
        });
      }
  
      fs.stat(outputImagePath, function (err, imageFileStat) {
        var imageNotExists = err && err.code === "ENOENT";
        if (!imageNotExists && err) {
          return reject({
            message: "Failed to stat image file",
            error: err
          });
        }
  
        // convert when (1) image doesn't exits or (2) image exists
        // but its timestamp is older than pdf's one
  
        if (imageNotExists) {
          // (1)
          convertPageToImage();
          return;
        }
  
        // image exist. check timestamp.
        fs.stat(pdfFilePath, function (err, pdfFileStat) {
          if (err) {
            return reject({
              message: "Failed to stat PDF file",
              error: err
            });
          }
  
          if (imageFileStat.mtime < pdfFileStat.mtime) {
            // (2)
            convertPageToImage();
            return;
          }
  
          return resolve(outputImagePath);
        });
      });
    });
    return promise;
  }

• example usage

  ...
  
  ## Usage
  
  ```javascript
  var PDFImage = require("pdf-image").PDFImage;
  
  var pdfImage = new PDFImage("/tmp/slide.pdf");
  pdfImage.convertPage(0).then(function (imagePath) {
    // 0-th page (first page) of the slide.pdf is available as slide-0.png
    fs.existsSync("/tmp/slide-0.png") // => true
  });
  ```
  
  ## Express
  ...

function pdf-image.PDFImage.prototype.getInfo ()

• description and source-code

  getInfo = function () {
    var self = this;
    var getInfoCommand = this.constructGetInfoCommand();
    var promise = new Promise(function (resolve, reject) {
      exec(getInfoCommand, function (err, stdout, stderr) {
        if (err) {
          return reject({
            message: "Failed to get PDF'S information",
            error: err,
            stdout: stdout,
            stderr: stderr
          });
        }
        return resolve(self.parseGetInfoCommandOutput(stdout));
      });
    });
    return promise;
  }

• example usage

  ...
        }
        return resolve(self.parseGetInfoCommandOutput(stdout));
      });
    });
    return promise;
  },
  numberOfPages: function () {
    return this.getInfo().then(function (info) {
      return info["Pages"];
    });
  },
  getOutputImagePathForPage: function (pageNumber) {
    return path.join(
      this.outputDirectory,
      this.pdfFileBaseName + "-" + pageNumber + "." + this.convertExtension
  ...

function pdf-image.PDFImage.prototype.getOutputImagePathForPage (pageNumber)

• description and source-code

  getOutputImagePathForPage = function (pageNumber) {
    return path.join(
      this.outputDirectory,
      this.pdfFileBaseName + "-" + pageNumber + "." + this.convertExtension
    );
  }

• example usage

  ...
    this.convertOptions = convertOptions || {};
  },
  setConvertExtension: function (convertExtension) {
    this.convertExtension = convertExtension || "png";
  },
  constructConvertCommandForPage: function (pageNumber) {
    var pdfFilePath = this.pdfFilePath;
    var outputImagePath = this.getOutputImagePathForPage(pageNumber);
    var convertOptionsString = this.constructConvertOptions();
    return util.format(
      "%s %s'%s[%d]' '%s'",
      this.useGM ? "gm convert" : "convert",
      convertOptionsString ? convertOptionsString + " " : "",
      pdfFilePath, pageNumber, outputImagePath
    );
  ...

function pdf-image.PDFImage.prototype.numberOfPages ()

• description and source-code

  numberOfPages = function () {
    return this.getInfo().then(function (info) {
      return info["Pages"];
    });
  }

• example usage

  n/a

function pdf-image.PDFImage.prototype.parseGetInfoCommandOutput (output)

• description and source-code

  parseGetInfoCommandOutput = function (output) {
    var info = {};
    output.split("\n").forEach(function (line) {
      if (line.match(/^(.*?):[ \t]*(.*)$/)) {
        info[RegExp.$1] = RegExp.$2;
      }
    });
    return info;
  }

• example usage

  ...
          return reject({
            message: "Failed to get PDF'S information",
            error: err,
            stdout: stdout,
            stderr: stderr
          });
        }
        return resolve(self.parseGetInfoCommandOutput(stdout));
      });
    });
    return promise;
  },
  numberOfPages: function () {
    return this.getInfo().then(function (info) {
      return info["Pages"];
  ...

function pdf-image.PDFImage.prototype.setConvertExtension (convertExtension)

• description and source-code

  setConvertExtension = function (convertExtension) {
    this.convertExtension = convertExtension || "png";
  }

• example usage

  ...
  function PDFImage(pdfFilePath, options) {
  if (!options) options = {};
  
  this.pdfFilePath = pdfFilePath;
  this.pdfFileBaseName = path.basename(pdfFilePath, ".pdf");
  
  this.setConvertOptions(options.convertOptions);
  this.setConvertExtension(options.convertExtension);
  this.useGM = options.graphicsMagick || false;
  
  this.outputDirectory = options.outputDirectory || path.dirname(pdfFilePath);
  }
  
  PDFImage.prototype = {
  constructGetInfoCommand: function () {
  ...

function pdf-image.PDFImage.prototype.setConvertOptions (convertOptions)

• description and source-code

  setConvertOptions = function (convertOptions) {
    this.convertOptions = convertOptions || {};
  }

• example usage

  ...
  
  function PDFImage(pdfFilePath, options) {
    if (!options) options = {};
  
    this.pdfFilePath = pdfFilePath;
    this.pdfFileBaseName = path.basename(pdfFilePath, ".pdf");
  
    this.setConvertOptions(options.convertOptions);
    this.setConvertExtension(options.convertExtension);
    this.useGM = options.graphicsMagick || false;
  
    this.outputDirectory = options.outputDirectory || path.dirname(pdfFilePath);
  }
  
  PDFImage.prototype = {
  ...