w-zip 1.0.14 → 1.0.16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (17) hide show
  1. package/.eslintrc.js +17 -17
  2. package/.jsdoc +1 -1
  3. package/LICENSE +1 -1
  4. package/babel.config.js +1 -0
  5. package/dist/w-zip.umd.js +2 -2
  6. package/dist/w-zip.umd.js.map +1 -1
  7. package/docs/index.html +4 -1
  8. package/docs/m7z.html +61 -46
  9. package/docs/m7z.mjs.html +4 -1
  10. package/docs/mZip.html +50 -37
  11. package/docs/mZip.mjs.html +4 -1
  12. package/docs/scripts/collapse.js +19 -0
  13. package/docs/scripts/commonNav.js +28 -0
  14. package/docs/scripts/search.js +16 -0
  15. package/docs/styles/jsdoc.css +13 -2
  16. package/docs/styles/prettify.css +1 -0
  17. package/package.json +5 -10
package/docs/m7z.html CHANGED
@@ -14,6 +14,7 @@
14
14
  <link type="text/css" rel="stylesheet" href="styles/prettify.css">
15
15
  <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
16
16
  <script src="scripts/nav.js" defer></script>
17
+
17
18
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
18
19
  </head>
19
20
  <body>
@@ -27,7 +28,9 @@
27
28
 
28
29
  <nav >
29
30
 
31
+
30
32
  <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>
33
+
31
34
  </nav>
32
35
 
33
36
  <div id="main">
@@ -45,7 +48,9 @@
45
48
  <header>
46
49
 
47
50
  <h2>
48
- m7z
51
+
52
+ m7z
53
+
49
54
  </h2>
50
55
 
51
56
 
@@ -67,6 +72,10 @@
67
72
 
68
73
 
69
74
  <dl class="details">
75
+
76
+ <dt class="tag-description">Description:</dt>
77
+ <dd class="tag-description"><ul class="dummy"><li><p>7z處理</p></li></ul></dd>
78
+
70
79
 
71
80
 
72
81
  <dt class="tag-source">Source:</dt>
@@ -110,19 +119,13 @@
110
119
 
111
120
 
112
121
 
113
- <div class="description usertext">
114
- <p>7z處理</p>
115
- </div>
116
-
117
-
118
-
119
122
 
120
123
 
121
124
 
122
125
 
123
126
 
124
127
 
125
- <h5>Example</h5>
128
+ <h5 class="h5-examples">Example</h5>
126
129
 
127
130
  <pre class="prettyprint"><code>import wz from 'w-zip'
128
131
  // //setProg
129
132
  // let path7zexe = 'path of 7zEXE'
130
133
  // wz.m7z.setProg(path7zexe)
131
134
  //zipFile
132
135
  console.log('zipFile before')
133
136
  console.log('zipFile', await wz.m7z.zipFile(fpSrc1, fpZip1))
134
137
  console.log('zipFile after')
135
138
  //zipFolder
136
139
  console.log('zipFolder before')
137
140
  console.log('zipFolder', await wz.m7z.zipFolder(fpSrc2, fpZip2))
138
141
  console.log('zipFolder after')
139
142
  //zipFolder with password
140
143
  console.log('zipFolder with password before')
141
144
  console.log('zipFolder with password', await wz.m7z.zipFolder(fpSrc2, fpZip2PW, { pw }))
142
145
  console.log('zipFolder with password after')
143
146
  //unzip
144
147
  console.log('unzip1 before')
145
148
  console.log('unzip1', await wz.m7z.unzip(fpZip1, fpUnzipExtract + '/test1'))
146
149
  console.log('unzip1 after')
147
150
  //unzip
148
151
  console.log('unzip2 before')
149
152
  console.log('unzip2', await wz.m7z.unzip(fpZip2, fpUnzipExtract + '/test2'))
150
153
  console.log('unzip2 after')
151
154
  //unzip with password
152
155
  console.log('unzip2 with password before')
153
156
  console.log('unzip2 with password', await wz.m7z.unzip(fpZip2PW, fpUnzipExtract + '/test2PW', { pw }))
154
157
  console.log('unzip2 with password after')
155
158
  .catch((err) => {
156
159
  console.log(err)
157
160
  })
158
161
 
@@ -143,7 +146,7 @@
143
146
 
144
147
 
145
148
 
146
- <h5>Returns:</h5>
149
+ <h5 class="h5-returns">Returns:</h5>
147
150
 
148
151
 
149
152
  <div class="param-desc">
@@ -161,6 +164,7 @@
161
164
  <span class="param-type">Object</span>
162
165
 
163
166
 
167
+
164
168
  </dd>
165
169
  </dl>
166
170
 
@@ -194,7 +198,7 @@
194
198
 
195
199
 
196
200
 
197
- <h4 class="name" id=".setProg"><span class="type-signature">(static) </span>setProg<span class="signature">(path7zexe<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Object}</span></h4>
201
+ <h4 class="name" id=".setProg"><span class="type-signature type-signature-static">(static) </span>setProg<span class="signature">(path7zexe<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Object}</span></h4>
198
202
 
199
203
 
200
204
 
@@ -202,6 +206,10 @@
202
206
 
203
207
 
204
208
  <dl class="details">
209
+
210
+ <dt class="tag-description">Description:</dt>
211
+ <dd class="tag-description"><ul class="dummy"><li><p>設定7z執行檔位置</p></li></ul></dd>
212
+
205
213
 
206
214
 
207
215
  <dt class="tag-source">Source:</dt>
@@ -245,12 +253,6 @@
245
253
 
246
254
 
247
255
 
248
- <div class="description usertext">
249
- <p>設定7z執行檔位置</p>
250
- </div>
251
-
252
-
253
-
254
256
 
255
257
 
256
258
 
@@ -259,7 +261,7 @@
259
261
 
260
262
 
261
263
 
262
- <h5>Parameters:</h5>
264
+ <h5 class="h5-parameters">Parameters:</h5>
263
265
 
264
266
 
265
267
  <table class="params">
@@ -297,6 +299,7 @@
297
299
  <span class="param-type">String</span>
298
300
 
299
301
 
302
+
300
303
 
301
304
  </td>
302
305
 
@@ -342,7 +345,7 @@
342
345
 
343
346
 
344
347
 
345
- <h5>Returns:</h5>
348
+ <h5 class="h5-returns">Returns:</h5>
346
349
 
347
350
 
348
351
  <div class="param-desc">
@@ -360,6 +363,7 @@
360
363
  <span class="param-type">Object</span>
361
364
 
362
365
 
366
+
363
367
  </dd>
364
368
  </dl>
365
369
 
@@ -372,7 +376,7 @@
372
376
 
373
377
 
374
378
 
375
- <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>
379
+ <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>
376
380
 
377
381
 
378
382
 
@@ -380,6 +384,10 @@
380
384
 
381
385
 
382
386
  <dl class="details">
387
+
388
+ <dt class="tag-description">Description:</dt>
389
+ <dd class="tag-description"><ul class="dummy"><li><p>解壓縮檔案至資料夾</p></li></ul></dd>
390
+
383
391
 
384
392
 
385
393
  <dt class="tag-source">Source:</dt>
@@ -423,11 +431,6 @@
423
431
 
424
432
 
425
433
 
426
- <div class="description usertext">
427
- <p>解壓縮檔案至資料夾</p>
428
- </div>
429
-
430
-
431
434
 
432
435
 
433
436
 
@@ -436,8 +439,7 @@
436
439
 
437
440
 
438
441
 
439
-
440
- <h5>Parameters:</h5>
442
+ <h5 class="h5-parameters">Parameters:</h5>
441
443
 
442
444
 
443
445
  <table class="params">
@@ -475,6 +477,7 @@
475
477
  <span class="param-type">String</span>
476
478
 
477
479
 
480
+
478
481
 
479
482
  </td>
480
483
 
@@ -510,6 +513,7 @@
510
513
  <span class="param-type">String</span>
511
514
 
512
515
 
516
+
513
517
 
514
518
  </td>
515
519
 
@@ -545,6 +549,7 @@
545
549
  <span class="param-type">Object</span>
546
550
 
547
551
 
552
+
548
553
 
549
554
  </td>
550
555
 
@@ -607,6 +612,7 @@
607
612
  <span class="param-type">String</span>
608
613
 
609
614
 
615
+
610
616
 
611
617
  </td>
612
618
 
@@ -659,7 +665,7 @@
659
665
 
660
666
 
661
667
 
662
- <h5>Returns:</h5>
668
+ <h5 class="h5-returns">Returns:</h5>
663
669
 
664
670
 
665
671
  <div class="param-desc">
@@ -677,6 +683,7 @@
677
683
  <span class="param-type">Promise</span>
678
684
 
679
685
 
686
+
680
687
  </dd>
681
688
  </dl>
682
689
 
@@ -689,7 +696,7 @@
689
696
 
690
697
 
691
698
 
692
- <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>
699
+ <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>
693
700
 
694
701
 
695
702
 
@@ -697,6 +704,10 @@
697
704
 
698
705
 
699
706
  <dl class="details">
707
+
708
+ <dt class="tag-description">Description:</dt>
709
+ <dd class="tag-description"><ul class="dummy"><li><p>壓縮檔案</p></li></ul></dd>
710
+
700
711
 
701
712
 
702
713
  <dt class="tag-source">Source:</dt>
@@ -740,12 +751,6 @@
740
751
 
741
752
 
742
753
 
743
- <div class="description usertext">
744
- <p>壓縮檔案</p>
745
- </div>
746
-
747
-
748
-
749
754
 
750
755
 
751
756
 
@@ -754,7 +759,7 @@
754
759
 
755
760
 
756
761
 
757
- <h5>Parameters:</h5>
762
+ <h5 class="h5-parameters">Parameters:</h5>
758
763
 
759
764
 
760
765
  <table class="params">
@@ -792,6 +797,7 @@
792
797
  <span class="param-type">String</span>
793
798
 
794
799
 
800
+
795
801
 
796
802
  </td>
797
803
 
@@ -827,6 +833,7 @@
827
833
  <span class="param-type">String</span>
828
834
 
829
835
 
836
+
830
837
 
831
838
  </td>
832
839
 
@@ -862,6 +869,7 @@
862
869
  <span class="param-type">Object</span>
863
870
 
864
871
 
872
+
865
873
 
866
874
  </td>
867
875
 
@@ -922,6 +930,7 @@
922
930
  <span class="param-type">Integer</span>
923
931
 
924
932
 
933
+
925
934
 
926
935
  </td>
927
936
 
@@ -955,6 +964,7 @@
955
964
  <span class="param-type">String</span>
956
965
 
957
966
 
967
+
958
968
 
959
969
  </td>
960
970
 
@@ -1001,7 +1011,7 @@
1001
1011
 
1002
1012
 
1003
1013
 
1004
- <h5>Returns:</h5>
1014
+ <h5 class="h5-returns">Returns:</h5>
1005
1015
 
1006
1016
 
1007
1017
  <div class="param-desc">
@@ -1019,6 +1029,7 @@
1019
1029
  <span class="param-type">Promise</span>
1020
1030
 
1021
1031
 
1032
+
1022
1033
  </dd>
1023
1034
  </dl>
1024
1035
 
@@ -1031,7 +1042,7 @@
1031
1042
 
1032
1043
 
1033
1044
 
1034
- <h4 class="name" id=".zipFolder"><span class="type-signature">(async, static) </span>zipFolder<span class="signature">(fpSrc, fpTar, opt<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
1045
+ <h4 class="name" id=".zipFolder"><span class="type-signature type-signature-async, static">(async, static) </span>zipFolder<span class="signature">(fpSrc, fpTar, opt<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
1035
1046
 
1036
1047
 
1037
1048
 
@@ -1039,6 +1050,10 @@
1039
1050
 
1040
1051
 
1041
1052
  <dl class="details">
1053
+
1054
+ <dt class="tag-description">Description:</dt>
1055
+ <dd class="tag-description"><ul class="dummy"><li><p>壓縮資料夾</p></li></ul></dd>
1056
+
1042
1057
 
1043
1058
 
1044
1059
  <dt class="tag-source">Source:</dt>
@@ -1082,12 +1097,6 @@
1082
1097
 
1083
1098
 
1084
1099
 
1085
- <div class="description usertext">
1086
- <p>壓縮資料夾</p>
1087
- </div>
1088
-
1089
-
1090
-
1091
1100
 
1092
1101
 
1093
1102
 
@@ -1096,7 +1105,7 @@
1096
1105
 
1097
1106
 
1098
1107
 
1099
- <h5>Parameters:</h5>
1108
+ <h5 class="h5-parameters">Parameters:</h5>
1100
1109
 
1101
1110
 
1102
1111
  <table class="params">
@@ -1134,6 +1143,7 @@
1134
1143
  <span class="param-type">String</span>
1135
1144
 
1136
1145
 
1146
+
1137
1147
 
1138
1148
  </td>
1139
1149
 
@@ -1169,6 +1179,7 @@
1169
1179
  <span class="param-type">String</span>
1170
1180
 
1171
1181
 
1182
+
1172
1183
 
1173
1184
  </td>
1174
1185
 
@@ -1204,6 +1215,7 @@
1204
1215
  <span class="param-type">Object</span>
1205
1216
 
1206
1217
 
1218
+
1207
1219
 
1208
1220
  </td>
1209
1221
 
@@ -1264,6 +1276,7 @@
1264
1276
  <span class="param-type">Integer</span>
1265
1277
 
1266
1278
 
1279
+
1267
1280
 
1268
1281
  </td>
1269
1282
 
@@ -1297,6 +1310,7 @@
1297
1310
  <span class="param-type">String</span>
1298
1311
 
1299
1312
 
1313
+
1300
1314
 
1301
1315
  </td>
1302
1316
 
@@ -1343,7 +1357,7 @@
1343
1357
 
1344
1358
 
1345
1359
 
1346
- <h5>Returns:</h5>
1360
+ <h5 class="h5-returns">Returns:</h5>
1347
1361
 
1348
1362
 
1349
1363
  <div class="param-desc">
@@ -1361,6 +1375,7 @@
1361
1375
  <span class="param-type">Promise</span>
1362
1376
 
1363
1377
 
1378
+
1364
1379
  </dd>
1365
1380
  </dl>
1366
1381
 
@@ -1388,7 +1403,7 @@
1388
1403
  <br class="clear">
1389
1404
 
1390
1405
  <footer>
1391
- 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.
1406
+ 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.
1392
1407
  </footer>
1393
1408
 
1394
1409
  <script>prettyPrint();</script>
package/docs/m7z.mjs.html CHANGED
@@ -14,6 +14,7 @@
14
14
  <link type="text/css" rel="stylesheet" href="styles/prettify.css">
15
15
  <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
16
16
  <script src="scripts/nav.js" defer></script>
17
+
17
18
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
18
19
  </head>
19
20
  <body>
@@ -27,7 +28,9 @@
27
28
 
28
29
  <nav >
29
30
 
31
+
30
32
  <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>
33
+
31
34
  </nav>
32
35
 
33
36
  <div id="main">
@@ -356,7 +359,7 @@ export default m7z()
356
359
  <br class="clear">
357
360
 
358
361
  <footer>
359
- 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.
362
+ 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.
360
363
  </footer>
361
364
 
362
365
  <script>prettyPrint();</script>