From b6a4dfd7d68ed627d2768a517e8d0e9cdcd6de66 Mon Sep 17 00:00:00 2001 From: Chris Talkington Date: Sat, 27 Aug 2016 15:22:49 -0500 Subject: [PATCH] update zip docs. --- lib/plugins/zip.js | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/lib/plugins/zip.js b/lib/plugins/zip.js index 7ec134e9..c294f864 100644 --- a/lib/plugins/zip.js +++ b/lib/plugins/zip.js @@ -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)) { @@ -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. */ /** @@ -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} */ \ No newline at end of file