modules/vfs.js

  1. /**
  2.  * @license
  3.  * jsPDF virtual FileSystem functionality
  4.  *
  5.  * Licensed under the MIT License.
  6.  * http://opensource.org/licenses/mit-license
  7.  */
  9. import { jsPDF } from "../jspdf.js";
  11. /**
  12.  * Use the vFS to handle files
  13.  *
  14.  * @name vFS
  15.  * @module
  16.  */
  17. (function(jsPDFAPI) {
  18.   "use strict";
  20.   var _initializeVFS = function() {
  21.     if (typeof this.internal.vFS === "undefined") {
  22.       this.internal.vFS = {};
  23.     }
  24.     return true;
  25.   };
  27.   /**
  28.    * Check if the file exists in the vFS
  29.    *
  30.    * @name existsFileInVFS
  31.    * @function
  32.    * @param {string} Possible filename in the vFS.
  33.    * @returns {boolean}
  34.    * @example
  35.    * doc.existsFileInVFS("someFile.txt");
  36.    */
  37.   jsPDFAPI.existsFileInVFS = function(filename) {
  38.     _initializeVFS.call(this);
  39.     return typeof this.internal.vFS[filename] !== "undefined";
  40.   };
  42.   /**
  43.    * Add a file to the vFS
  44.    *
  45.    * @name addFileToVFS
  46.    * @function
  47.    * @param {string} filename The name of the file which should be added.
  48.    * @param {string} filecontent The content of the file.
  49.    * @returns {jsPDF}
  50.    * @example
  51.    * doc.addFileToVFS("someFile.txt", "BADFACE1");
  52.    */
  53.   jsPDFAPI.addFileToVFS = function(filename, filecontent) {
  54.     _initializeVFS.call(this);
  55.     this.internal.vFS[filename] = filecontent;
  56.     return this;
  57.   };
  59.   /**
  60.    * Get the file from the vFS
  61.    *
  62.    * @name getFileFromVFS
  63.    * @function
  64.    * @param {string} The name of the file which gets requested.
  65.    * @returns {string}
  66.    * @example
  67.    * doc.getFileFromVFS("someFile.txt");
  68.    */
  69.   jsPDFAPI.getFileFromVFS = function(filename) {
  70.     _initializeVFS.call(this);
  72.     if (typeof this.internal.vFS[filename] !== "undefined") {
  73.       return this.internal.vFS[filename];
  74.     }
  75.     return null;
  76.   };
  77. })(jsPDF.API);