Skip to content

Commit

Permalink
update zip docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
ctalkington committed Aug 27, 2016
1 parent 1fbe461 commit b6a4dfd
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions lib/plugins/zip.js
Expand Up @@ -16,6 +16,7 @@ var util = require('archiver-utils');
* @param {Boolean} [options.forceZip64=false] Forces the archive to contain ZIP64 headers.
* @param {Boolean} [options.store=false] Sets the compression method to STORE.
* @param {Object} [options.zlib] Passed to [zlib]{@link https://nodejs.org/api/zlib.html#zlib_class_options}
* @property {ZipStream} [engine]
*/
var Zip = function(options) {
if (!(this instanceof Zip)) {
Expand Down Expand Up @@ -83,16 +84,18 @@ Zip.prototype.unpipe = function() {

module.exports = Zip;



/**
* @typedef {Object} ZipOptions
* @global
* @property {String} [comment] Sets the zip archive comment.
* @param {Boolean} [forceLocalTime=false] Forces the archive to contain local file times instead of UTC.
* @param {Boolean} [forceZip64=false] Forces the archive to contain ZIP64 headers.
* @property {Boolean} [forceLocalTime=false] Forces the archive to contain local file times instead of UTC.
* @property {Boolean} [forceZip64=false] Forces the archive to contain ZIP64 headers.
* @property {Boolean} [store=false] Sets the compression method to STORE.
* @property {Object} [zlib] Passed to [zlib]{@link https://nodejs.org/api/zlib.html#zlib_class_options}
* to control compression.
* @property {*} [*] See [zip-stream]{@link https://archiverjs.com/zip-stream/ZipStream.html} documentation for additional properties.
* @property {*} [*] See [zip-stream]{@link } documentation for current list of properties.
*/

/**
Expand All @@ -106,4 +109,10 @@ module.exports = Zip;
* @property {fs.Stats} [stats] Sets the fs stat data for this entry allowing
* for reduction of fs stat calls when stat data is already known.
* @property {Boolean} [store=ZipOptions.store] Sets the compression method to STORE.
*/

/**
* ZipStream
* @external ZipStream
* @see {@link https://archiverjs.com/zip-stream/ZipStream.html}
*/

0 comments on commit b6a4dfd

Please sign in to comment.