w-zip 1.0.14 → 1.0.16

package/docs/mZip.html

@@ -14,6 +14,7 @@
     <link type="text/css" rel="stylesheet" href="styles/prettify.css">
     <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
     <script src="scripts/nav.js" defer></script>
+    
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
 </head>
 <body>
@@ -27,7 +28,9 @@
 
 <nav >
     
+    
     <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="m7z.html">m7z</a><ul class='methods'><li data-type='method'><a href="m7z.html#.setProg">setProg</a></li><li data-type='method'><a href="m7z.html#.unzip">unzip</a></li><li data-type='method'><a href="m7z.html#.zipFile">zipFile</a></li><li data-type='method'><a href="m7z.html#.zipFolder">zipFolder</a></li></ul></li><li><a href="mZip.html">mZip</a><ul class='methods'><li data-type='method'><a href="mZip.html#.unzip">unzip</a></li><li data-type='method'><a href="mZip.html#.zipFile">zipFile</a></li><li data-type='method'><a href="mZip.html#.zipFolder">zipFolder</a></li></ul></li></ul>
+    
 </nav>
 
 <div id="main">
@@ -45,7 +48,9 @@
 <header>
     
         <h2>
-        mZip
+        
+            mZip
+        
         </h2>
         
     
@@ -67,6 +72,10 @@
 
 
 <dl class="details">
+    
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>Zip處理</p></li></ul></dd>
+    
 
     
     <dt class="tag-source">Source:</dt>
@@ -110,19 +119,13 @@
 
 
 
-<div class="description usertext">
-    <p>Zip處理</p>
-</div>
-
-
-
 
 
 
 
 
 
-    <h5>Example</h5>
+    <h5 class="h5-examples">Example</h5>
     
     <pre class="prettyprint"><code>import wz from 'w-zip'
    //zipFile
    console.log('zipFile before')
    console.log('zipFile', await wz.mZip.zipFile(fpSrc1, fpZip1))
    console.log('zipFile after')
    //zipFolder
    console.log('zipFolder before')
    console.log('zipFolder', await wz.mZip.zipFolder(fpSrc2, fpZip2))
    console.log('zipFolder after')
    //zipFolder with password
    console.log('zipFolder with password before')
    console.log('zipFolder with password', await wz.mZip.zipFolder(fpSrc2, fpZip2PW, { pw }))
    console.log('zipFolder with password after')
    //unzip
    console.log('unzip1 before')
    console.log('unzip1', await wz.mZip.unzip(fpZip1, fpUnzipExtract + '/test1'))
    console.log('unzip1 after')
    //unzip
    console.log('unzip2 before')
    console.log('unzip2', await wz.mZip.unzip(fpZip2, fpUnzipExtract + '/test2'))
    console.log('unzip2 after')
    //unzip with password
    console.log('unzip2 with password before')
    console.log('unzip2 with password', await wz.mZip.unzip(fpZip2PW, fpUnzipExtract + '/test2PW', { pw }))
    console.log('unzip2 with password after')
    .catch((err) => {
        console.log(err)
    })
 
@@ -143,7 +146,7 @@
 
 
 
-<h5>Returns:</h5>
+<h5 class="h5-returns">Returns:</h5>
 
         
 <div class="param-desc">
@@ -161,6 +164,7 @@
 <span class="param-type">Object</span>
 
 
+
     </dd>
 </dl>
 
@@ -194,7 +198,7 @@
 
     
 
-    <h4 class="name" id=".unzip"><span class="type-signature">(async, static) </span>unzip<span class="signature">(fpSrc, fpTar, opt<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
+    <h4 class="name" id=".unzip"><span class="type-signature type-signature-async, static">(async, static) </span>unzip<span class="signature">(fpSrc, fpTar, opt<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
 
     
 
@@ -202,6 +206,10 @@
 
 
 <dl class="details">
+    
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>解壓縮檔案至資料夾</p></li></ul></dd>
+    
 
     
     <dt class="tag-source">Source:</dt>
@@ -245,12 +253,6 @@
 
 
 
-<div class="description usertext">
-    <p>解壓縮檔案至資料夾</p>
-</div>
-
-
-
 
 
 
@@ -259,7 +261,7 @@
 
 
 
-    <h5>Parameters:</h5>
+    <h5 class="h5-parameters">Parameters:</h5>
     
 
 <table class="params">
@@ -297,6 +299,7 @@
 <span class="param-type">String</span>
 
 
+
             
             </td>
 
@@ -332,6 +335,7 @@
 <span class="param-type">String</span>
 
 
+
             
             </td>
 
@@ -367,6 +371,7 @@
 <span class="param-type">Object</span>
 
 
+
             
             </td>
 
@@ -429,6 +434,7 @@
 <span class="param-type">String</span>
 
 
+
             
             </td>
 
@@ -481,7 +487,7 @@
 
 
 
-<h5>Returns:</h5>
+<h5 class="h5-returns">Returns:</h5>
 
         
 <div class="param-desc">
@@ -499,6 +505,7 @@
 <span class="param-type">Promise</span>
 
 
+
     </dd>
 </dl>
 
@@ -511,7 +518,7 @@
 
     
 
-    <h4 class="name" id=".zipFile"><span class="type-signature">(async, static) </span>zipFile<span class="signature">(fpSrc, fpTar, opt<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
+    <h4 class="name" id=".zipFile"><span class="type-signature type-signature-async, static">(async, static) </span>zipFile<span class="signature">(fpSrc, fpTar, opt<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
 
     
 
@@ -519,6 +526,10 @@
 
 
 <dl class="details">
+    
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>壓縮檔案</p></li></ul></dd>
+    
 
     
     <dt class="tag-source">Source:</dt>
@@ -562,12 +573,6 @@
 
 
 
-<div class="description usertext">
-    <p>壓縮檔案</p>
-</div>
-
-
-
 
 
 
@@ -576,7 +581,7 @@
 
 
 
-    <h5>Parameters:</h5>
+    <h5 class="h5-parameters">Parameters:</h5>
     
 
 <table class="params">
@@ -614,6 +619,7 @@
 <span class="param-type">String</span>
 
 
+
             
             </td>
 
@@ -649,6 +655,7 @@
 <span class="param-type">String</span>
 
 
+
             
             </td>
 
@@ -684,6 +691,7 @@
 <span class="param-type">Object</span>
 
 
+
             
             </td>
 
@@ -744,6 +752,7 @@
 <span class="param-type">Integer</span>
 
 
+
             
             </td>
 
@@ -777,6 +786,7 @@
 <span class="param-type">String</span>
 
 
+
             
             </td>
 
@@ -823,7 +833,7 @@
 
 
 
-<h5>Returns:</h5>
+<h5 class="h5-returns">Returns:</h5>
 
         
 <div class="param-desc">
@@ -841,6 +851,7 @@
 <span class="param-type">Promise</span>
 
 
+
     </dd>
 </dl>
 
@@ -853,7 +864,7 @@
 
     
 
-    <h4 class="name" id=".zipFolder"><span class="type-signature">(async, static) </span>zipFolder<span class="signature">(fpSrc, fpTar, level)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
+    <h4 class="name" id=".zipFolder"><span class="type-signature type-signature-async, static">(async, static) </span>zipFolder<span class="signature">(fpSrc, fpTar, level)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
 
     
 
@@ -861,6 +872,10 @@
 
 
 <dl class="details">
+    
+    <dt class="tag-description">Description:</dt>
+    <dd class="tag-description"><ul class="dummy"><li><p>壓縮資料夾</p></li></ul></dd>
+    
 
     
     <dt class="tag-source">Source:</dt>
@@ -904,11 +919,6 @@
 
 
 
-<div class="description usertext">
-    <p>壓縮資料夾</p>
-</div>
-
-
 
 
 
@@ -917,8 +927,7 @@
 
 
 
-
-    <h5>Parameters:</h5>
+    <h5 class="h5-parameters">Parameters:</h5>
     
 
 <table class="params">
@@ -952,6 +961,7 @@
 <span class="param-type">String</span>
 
 
+
             
             </td>
 
@@ -975,6 +985,7 @@
 <span class="param-type">String</span>
 
 
+
             
             </td>
 
@@ -998,6 +1009,7 @@
 <span class="param-type">Integer</span>
 
 
+
             
             </td>
 
@@ -1027,7 +1039,7 @@
 
 
 
-<h5>Returns:</h5>
+<h5 class="h5-returns">Returns:</h5>
 
         
 <div class="param-desc">
@@ -1045,6 +1057,7 @@
 <span class="param-type">Promise</span>
 
 
+
     </dd>
 </dl>
 
@@ -1072,7 +1085,7 @@
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a> on Thu Apr 07 2022 16:09:36 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Wed Mar 29 2023 15:18:57 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/mZip.mjs.html

@@ -14,6 +14,7 @@
     <link type="text/css" rel="stylesheet" href="styles/prettify.css">
     <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
     <script src="scripts/nav.js" defer></script>
+    
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
 </head>
 <body>
@@ -27,7 +28,9 @@
 
 <nav >
     
+    
     <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="m7z.html">m7z</a><ul class='methods'><li data-type='method'><a href="m7z.html#.setProg">setProg</a></li><li data-type='method'><a href="m7z.html#.unzip">unzip</a></li><li data-type='method'><a href="m7z.html#.zipFile">zipFile</a></li><li data-type='method'><a href="m7z.html#.zipFolder">zipFolder</a></li></ul></li><li><a href="mZip.html">mZip</a><ul class='methods'><li data-type='method'><a href="mZip.html#.unzip">unzip</a></li><li data-type='method'><a href="mZip.html#.zipFile">zipFile</a></li><li data-type='method'><a href="mZip.html#.zipFolder">zipFolder</a></li></ul></li></ul>
+    
 </nav>
 
 <div id="main">
@@ -430,7 +433,7 @@ export default mZip()
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a> on Thu Apr 07 2022 16:09:36 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Wed Mar 29 2023 15:18:57 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/scripts/collapse.js

@@ -1,15 +1,34 @@
 function hideAllButCurrent(){
     //by default all submenut items are hidden
     //but we need to rehide them for search
+    document.querySelectorAll("nav > ul").forEach(function(parent) {
+        if (parent.className.indexOf("collapse_top") !== -1) {
+            parent.style.display = "none";
+        }
+    });
     document.querySelectorAll("nav > ul > li > ul li").forEach(function(parent) {
         parent.style.display = "none";
     });
+    document.querySelectorAll("nav > h3").forEach(function(section) {
+        if (section.className.indexOf("collapsed_header") !== -1) {
+            section.addEventListener("click", function(){
+                if (section.nextSibling.style.display === "none") {
+                    section.nextSibling.style.display = "block";
+                } else {
+                    section.nextSibling.style.display = "none";
+                }
+            });
+        }
+    });
     
     //only current page (if it exists) should be opened
     var file = window.location.pathname.split("/").pop().replace(/\.html/, '');
     document.querySelectorAll("nav > ul > li > a").forEach(function(parent) {
         var href = parent.attributes.href.value.replace(/\.html/, '');
         if (file === href) {
+            if (parent.parentNode.parentNode.className.indexOf("collapse_top") !== -1) {
+                parent.parentNode.parentNode.style.display = "block";
+            }
             parent.parentNode.querySelectorAll("ul li").forEach(function(elem) {
                 elem.style.display = "block";
             });

package/docs/scripts/commonNav.js

@@ -0,0 +1,28 @@
+if (typeof fetch === 'function') {
+  const init = () => {
+    if (typeof scrollToNavItem !== 'function') return false
+    scrollToNavItem()
+    // hideAllButCurrent not always loaded
+    if (typeof hideAllButCurrent === 'function') hideAllButCurrent()
+    return true
+  }
+  fetch('./nav.inc.html')
+    .then(response => response.ok ? response.text() : `${response.url} => ${response.status} ${response.statusText}`)
+    .then(body => {
+      document.querySelector('nav').innerHTML += body
+      // nav.js should be quicker to load than nav.inc.html, a fallback just in case
+      return init()
+    })
+    .then(done => {
+      if (done) return
+      let i = 0
+      ;(function waitUntilNavJs () {
+        if (init()) return
+        if (i++ < 100) return setTimeout(waitUntilNavJs, 300)
+        console.error(Error('nav.js not loaded after 30s waiting for it'))
+      })()
+    })
+    .catch(error => console.error(error))
+} else {
+  console.error(Error('Browser too old to display commonNav (remove commonNav docdash option)'))
+}

package/docs/scripts/search.js

@@ -33,6 +33,9 @@ document.getElementById("nav-search").addEventListener("keyup", function(event)
         document.querySelectorAll("nav > ul > li").forEach(function(elem) {
             elem.style.display = "block";
         });
+        document.querySelectorAll("nav > ul").forEach(function(elem) {
+            elem.style.display = "block";
+        });
         //hide all results
         document.querySelectorAll("nav > ul > li > ul li").forEach(function(elem) {
             elem.style.display = "none";
@@ -79,5 +82,18 @@ document.getElementById("nav-search").addEventListener("keyup", function(event)
                 parent.style.display = "none";
             }
         });
+        document.querySelectorAll("nav > ul.collapse_top").forEach(function(parent) {
+            var countVisible = 0;
+            parent.querySelectorAll("li").forEach(function(elem) {
+                if (elem.style.display !== "none") {
+                    countVisible++;
+                }
+            });
+          
+            if (countVisible == 0) {
+                //has no child at all and does not contain text
+                parent.style.display = "none";
+            }
+        });
     }
 });

package/docs/styles/jsdoc.css

@@ -162,12 +162,19 @@ h6 {
 }
 
 
-tt, code, kbd, samp {
+tt, code, kbd, samp, pre {
   font-family: Consolas, Monaco, 'Andale Mono', monospace;
   background: #f4f4f4;
+}
+
+tt, code, kbd, samp{
   padding: 1px 5px;
 }
 
+pre {
+  padding-bottom: 1em;
+}  
+
 .class-description {
   font-size: 130%;
   line-height: 140%;
@@ -242,6 +249,10 @@ nav h3 {
   color: #000;
 }
 
+nav h3.collapsed_header {
+  cursor: pointer;
+}
+
 nav ul {
   font-family: 'Lucida Grande', 'Lucida Sans Unicode', arial, sans-serif;
   font-size: 100%;
@@ -762,4 +773,4 @@ html[data-search-mode] .level-hide {
     font-weight: 300;
     font-style: normal;
 
-}
+}

package/docs/styles/prettify.css

@@ -76,4 +76,5 @@
 ol.linenums {
   margin-top: 0;
   margin-bottom: 0;
+  padding-bottom: 2px;
 }

package/package.json

@@ -1,17 +1,16 @@
 {
   "name": "w-zip",
-  "version": "1.0.14",
-  "description": "A compression tool with zip and 7z.",
+  "version": "1.0.16",
   "main": "dist/w-zip.umd.js",
   "dependencies": {
-    "archiver": "^5.3.0",
+    "archiver": "^5.3.1",
     "archiver-zip-encrypted": "^1.0.11",
     "unzipper": "^0.10.11",
     "lodash": "^4.17.21",
-    "wsemi": "^1.6.54"
+    "wsemi": "^1.7.1"
   },
   "devDependencies": {
-    "w-package-tools": "^1.0.65"
+    "w-package-tools": "^1.0.68"
   },
   "scripts": {
     "test": "mocha --parallel --timeout 60000 --experimental-modules --es-module-specifier-resolution=node",
@@ -30,9 +29,5 @@
     "nodejs"
   ],
   "author": "yuda-lyu(semisphere)",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/yuda-lyu/w-zip/issues"
-  },
-  "homepage": "https://github.com/yuda-lyu/w-zip#readme"
+  "license": "MIT"
 }