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 f3b1d6d commit 1fbe461
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion lib/plugins/zip.js
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,27 @@ 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} [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.
*/

/**
* @typedef {Object} ZipEntryData
* @global
*
* @property {String} name Sets the entry name including internal path.
* @property {(String|Date)} [date=NOW()] Sets the entry date.
* @property {Number} [mode=D:0755/F:0644] Sets the entry permissions.
* @property {String} [prefix] Sets a path prefix for the entry name. Useful
* when working with methods like `directory` or `glob`.
* @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.
*/

0 comments on commit 1fbe461

Please sign in to comment.