1. module yazl
   1. function yazl.ZipFile ()
   2. function yazl.dateToDosDateTime (jsDate)
   3. object yazl.ZipFile.prototype
2. module yazl.ZipFile
   1. function yazl.ZipFile ()
   2. function yazl.ZipFile.super_ ()
3. module yazl.ZipFile.prototype
   1. function yazl.ZipFile.prototype.addBuffer (buffer, metadataPath, options)
   2. function yazl.ZipFile.prototype.addEmptyDirectory (metadataPath, options)
   3. function yazl.ZipFile.prototype.addFile (realPath, metadataPath, options)
   4. function yazl.ZipFile.prototype.addReadStream (readStream, metadataPath, options)
   5. function yazl.ZipFile.prototype.end (options, finalSizeCallback)

module yazl

function yazl.ZipFile ()

• description and source-code

  function ZipFile() {
    this.outputStream = new PassThrough();
    this.entries = [];
    this.outputStreamCursor = 0;
    this.ended = false; // .end() sets this
    this.allDone = false; // set when we've written the last bytes
    this.forceZip64Eocd = false; // configurable in .end()
  }

• example usage

  ...
     but avoids OS-imposed limits on the number of simultaneously open file handles.
  
  ## Usage
  
  ```js
  var yazl = require("yazl");
  
  var zipfile = new yazl.ZipFile();
  zipfile.addFile("file1.txt", "file1.txt");
  // (add only files, not directories)
  zipfile.addFile("path/to/file.txt", "path/in/zipfile.txt");
  // pipe() can be called any time after the constructor
  zipfile.outputStream.pipe(fs.createWriteStream("output.zip")).on("close", function() {
    console.log("done");
  });
  ...

function yazl.dateToDosDateTime (jsDate)

• description and source-code

  function dateToDosDateTime(jsDate) {
    var date = 0;
    date |= jsDate.getDate() & 0x1f; // 1-31
    date |= ((jsDate.getMonth() + 1) & 0xf) << 5; // 0-11, 1-12
    date |= ((jsDate.getFullYear() - 1980) & 0x7f) << 9; // 0-128, 1980-2108
  
    var time = 0;
    time |= Math.floor(jsDate.getSeconds() / 2); // 0-59, 0-29 (lose odd numbers)
    time |= (jsDate.getMinutes() & 0x3f) << 5; // 0-59
    time |= (jsDate.getHours() & 0x1f) << 11; // 0-23
  
    return {date: date, time: time};
  }

• example usage

  n/a

module yazl.ZipFile

function yazl.ZipFile ()

• description and source-code

  function ZipFile() {
    this.outputStream = new PassThrough();
    this.entries = [];
    this.outputStreamCursor = 0;
    this.ended = false; // .end() sets this
    this.allDone = false; // set when we've written the last bytes
    this.forceZip64Eocd = false; // configurable in .end()
  }

• example usage

  ...
     but avoids OS-imposed limits on the number of simultaneously open file handles.
  
  ## Usage
  
  ```js
  var yazl = require("yazl");
  
  var zipfile = new yazl.ZipFile();
  zipfile.addFile("file1.txt", "file1.txt");
  // (add only files, not directories)
  zipfile.addFile("path/to/file.txt", "path/in/zipfile.txt");
  // pipe() can be called any time after the constructor
  zipfile.outputStream.pipe(fs.createWriteStream("output.zip")).on("close", function() {
    console.log("done");
  });
  ...

function yazl.ZipFile.super_ ()

• description and source-code

  function EventEmitter() {
    EventEmitter.init.call(this);
  }

• example usage

  n/a

module yazl.ZipFile.prototype

function yazl.ZipFile.prototype.addBuffer (buffer, metadataPath, options)

• description and source-code

  addBuffer = function (buffer, metadataPath, options) {
    var self = this;
    metadataPath = validateMetadataPath(metadataPath, false);
    if (buffer.length > 0x3fffffff) throw new Error("buffer too large: " + buffer.length + " > " + 0x3fffffff);
    if (options == null) options = {};
    if (options.size != null) throw new Error("options.size not allowed");
    var entry = new Entry(metadataPath, false, options);
    entry.uncompressedSize = buffer.length;
    entry.crc32 = crc32.unsigned(buffer);
    entry.crcAndFileSizeKnown = true;
    self.entries.push(entry);
    if (!entry.compress) {
      setCompressedBuffer(buffer);
    } else {
      zlib.deflateRaw(buffer, function(err, compressedBuffer) {
        setCompressedBuffer(compressedBuffer);
      });
    }
    function setCompressedBuffer(compressedBuffer) {
      entry.compressedSize = compressedBuffer.length;
      entry.setFileDataPumpFunction(function() {
        writeToOutputStream(self, compressedBuffer);
        writeToOutputStream(self, entry.getDataDescriptor());
        entry.state = Entry.FILE_DATA_DONE;
  
        // don't call pumpEntries() recursively.
        // (also, don't call process.nextTick recursively.)
        setImmediate(function() {
          pumpEntries(self);
        });
      });
      pumpEntries(self);
    }
  }

• example usage

  ...
    console.log("done");
  });
  // alternate apis for adding files:
  zipfile.addReadStream(process.stdin, "stdin.txt", {
    mtime: new Date(),
    mode: parseInt("0100664", 8), // -rw-rw-r--
  });
  zipfile.addBuffer(new Buffer("hello"), "hello.txt", {
    mtime: new Date(),
    mode: parseInt("0100664", 8), // -rw-rw-r--
  });
  // call end() after all the files have been added
  zipfile.end();
  ```
  ...

function yazl.ZipFile.prototype.addEmptyDirectory (metadataPath, options)

• description and source-code

  addEmptyDirectory = function (metadataPath, options) {
    var self = this;
    metadataPath = validateMetadataPath(metadataPath, true);
    if (options == null) options = {};
    if (options.size != null) throw new Error("options.size not allowed");
    if (options.compress != null) throw new Error("options.compress not allowed");
    var entry = new Entry(metadataPath, true, options);
    self.entries.push(entry);
    entry.setFileDataPumpFunction(function() {
      writeToOutputStream(self, entry.getDataDescriptor());
      entry.state = Entry.FILE_DATA_DONE;
      pumpEntries(self);
    });
    pumpEntries(self);
  }

• example usage

  n/a

function yazl.ZipFile.prototype.addFile (realPath, metadataPath, options)

• description and source-code

  addFile = function (realPath, metadataPath, options) {
    var self = this;
    metadataPath = validateMetadataPath(metadataPath, false);
    if (options == null) options = {};
  
    var entry = new Entry(metadataPath, false, options);
    self.entries.push(entry);
    fs.stat(realPath, function(err, stats) {
      if (err) return self.emit("error", err);
      if (!stats.isFile()) return self.emit("error", new Error("not a file: " + realPath));
      entry.uncompressedSize = stats.size;
      if (options.mtime == null) entry.setLastModDate(stats.mtime);
      if (options.mode == null) entry.setFileAttributesMode(stats.mode);
      entry.setFileDataPumpFunction(function() {
        var readStream = fs.createReadStream(realPath);
        entry.state = Entry.FILE_DATA_IN_PROGRESS;
        readStream.on("error", function(err) {
          self.emit("error", err);
        });
        pumpFileDataReadStream(self, entry, readStream);
      });
      pumpEntries(self);
    });
  }

• example usage

  ...
  
  ## Usage
  
  ```js
  var yazl = require("yazl");
  
  var zipfile = new yazl.ZipFile();
  zipfile.addFile("file1.txt", "file1.txt");
  // (add only files, not directories)
  zipfile.addFile("path/to/file.txt", "path/in/zipfile.txt");
  // pipe() can be called any time after the constructor
  zipfile.outputStream.pipe(fs.createWriteStream("output.zip")).on("close", function() {
    console.log("done");
  });
  // alternate apis for adding files:
  ...

function yazl.ZipFile.prototype.addReadStream (readStream, metadataPath, options)

• description and source-code

  addReadStream = function (readStream, metadataPath, options) {
    var self = this;
    metadataPath = validateMetadataPath(metadataPath, false);
    if (options == null) options = {};
    var entry = new Entry(metadataPath, false, options);
    self.entries.push(entry);
    entry.setFileDataPumpFunction(function() {
      entry.state = Entry.FILE_DATA_IN_PROGRESS;
      pumpFileDataReadStream(self, entry, readStream);
    });
    pumpEntries(self);
  }

• example usage

  ...
  // (add only files, not directories)
  zipfile.addFile("path/to/file.txt", "path/in/zipfile.txt");
  // pipe() can be called any time after the constructor
  zipfile.outputStream.pipe(fs.createWriteStream("output.zip")).on("close", function() {
    console.log("done");
  });
  // alternate apis for adding files:
  zipfile.addReadStream(process.stdin, "stdin.txt", {
    mtime: new Date(),
    mode: parseInt("0100664", 8), // -rw-rw-r--
  });
  zipfile.addBuffer(new Buffer("hello"), "hello.txt", {
    mtime: new Date(),
    mode: parseInt("0100664", 8), // -rw-rw-r--
  });
  ...

function yazl.ZipFile.prototype.end (options, finalSizeCallback)

• description and source-code

  end = function (options, finalSizeCallback) {
    if (typeof options === "function") {
      finalSizeCallback = options;
      options = null;
    }
    if (options == null) options = {};
    if (this.ended) return;
    this.ended = true;
    this.finalSizeCallback = finalSizeCallback;
    this.forceZip64Eocd = !!options.forceZip64Format;
    pumpEntries(this);
  }

• example usage

  ...
  exports.dateToDosDateTime = dateToDosDateTime;
  
  util.inherits(ZipFile, EventEmitter);
  function ZipFile() {
  this.outputStream = new PassThrough();
  this.entries = [];
  this.outputStreamCursor = 0;
  this.ended = false; // .end() sets this
  this.allDone = false; // set when we've written the last bytes
  this.forceZip64Eocd = false; // configurable in .end()
  }
  
  ZipFile.prototype.addFile = function(realPath, metadataPath, options) {
  var self = this;
  metadataPath = validateMetadataPath(metadataPath, false);
  ...