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 d912b04 commit b2464f8
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions lib/plugins/zip.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,12 @@ var util = require('archiver-utils');

/**
* @constructor
* @param {ZipOptions} options
* @param {Object} [options]
* @param {String} [options.comment] Sets the zip archive comment.
* @param {Boolean} [options.forceLocalTime=false] Forces the archive to contain local file times instead of UTC.
* @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}
*/
var Zip = function(options) {
if (!(this instanceof Zip)) {
Expand Down Expand Up @@ -74,10 +79,12 @@ 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} [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://github.com/archiverjs/node-zip-stream} documentation for additional properties.
* @property {*} [*] See [zip-stream]{@link https://archiverjs.com/zip-stream/ZipStream.html} documentation for additional properties.
*/

/**
Expand Down

0 comments on commit b2464f8

Please sign in to comment.