|
47 | 47 |
|
48 | 48 | ### Extract: `Zip.extract` |
49 | 49 |
|
50 | | - **Arguments** |
51 | | - * `archive` The path to the archive you want to analyse. |
52 | | - * `dest` Where to extract the archive. |
53 | | - * `options` An object of options. |
54 | | - |
55 | | - **Progress** |
56 | | - * `files` A array of all the extracted files *AND* directories. The `/` |
57 | | - character is used as a path separator on every platform. |
58 | | - |
59 | | - **Error** |
60 | | - * `err` An Error object. |
| 50 | +**Arguments** |
| 51 | + * `archive` The path to the archive you want to analyse. |
| 52 | + * `dest` Where to extract the archive. |
| 53 | + * `options` An object of options. |
| 54 | + |
| 55 | +**Progress** |
| 56 | + * `files` A array of all the extracted files *AND* directories. The `/` |
| 57 | + character is used as a path separator on every platform. |
| 58 | + |
| 59 | +**Error** |
| 60 | + * `err` An Error object. |
61 | 61 |
|
62 | 62 |
|
63 | 63 | ### Extract with full paths: `Zip.extractFull` |
64 | 64 |
|
65 | | - **Arguments** |
66 | | - * `archive` The path to the archive you want to analyse. |
67 | | - * `dest` Where to extract the archive. |
68 | | - * `options` An object of options. |
69 | | - |
70 | | - **Progress** |
71 | | - * `files` A array of all the extracted files *AND* directories. The `/` |
72 | | - character is used as a path separator on every platform. |
73 | | - |
74 | | - **Error** |
75 | | - * `err` An Error object. |
| 65 | +**Arguments** |
| 66 | + * `archive` The path to the archive you want to analyse. |
| 67 | + * `dest` Where to extract the archive. |
| 68 | + * `options` An object of options. |
| 69 | + |
| 70 | +**Progress** |
| 71 | + * `files` A array of all the extracted files *AND* directories. The `/` |
| 72 | + character is used as a path separator on every platform. |
| 73 | + |
| 74 | +**Error** |
| 75 | + * `err` An Error object. |
76 | 76 |
|
77 | 77 |
|
78 | 78 | ### Test integrity of archive: `Zip.test` |
79 | 79 |
|
80 | | - **Arguments** |
81 | | - * `archive` The path to the archive you want to analyse. |
82 | | - * `options` An object of options. |
83 | | - |
84 | | - **Progress** |
85 | | - * `files` A array of all the extracted files *AND* directories. The `/` |
86 | | - character is used as a path separator on every platform. |
87 | | - |
88 | | - **Error** |
89 | | - * `err` An Error object. |
| 80 | +**Arguments** |
| 81 | + * `archive` The path to the archive you want to analyse. |
| 82 | + * `options` An object of options. |
| 83 | + |
| 84 | +**Progress** |
| 85 | + * `files` A array of all the extracted files *AND* directories. The `/` |
| 86 | + character is used as a path separator on every platform. |
| 87 | + |
| 88 | +**Error** |
| 89 | + * `err` An Error object. |
90 | 90 |
|
91 | 91 |
|
92 | 92 | ### List contents of archive: `Zip.list` |
93 | 93 |
|
94 | | - **Arguments** |
95 | | - * `archive` The path to the archive you want to analyse. |
96 | | - * `options` An object of options. |
97 | | - |
98 | | - **Progress** |
99 | | - * `files` A array of all the extracted files *AND* directories. The `/` |
100 | | - character is used as a path separator on every platform. |
101 | | - |
102 | | - **Fulfill** |
103 | | - * `spec` An object of tech spec about the archive. Properties are: `date`, |
104 | | - `attr`, `size` and `name`. |
105 | | - |
106 | | - **Error** |
107 | | - * `err` An Error object. |
| 94 | +**Arguments** |
| 95 | + * `archive` The path to the archive you want to analyse. |
| 96 | + * `options` An object of options. |
| 97 | + |
| 98 | +**Progress** |
| 99 | + * `files` A array of all the extracted files *AND* directories. The `/` |
| 100 | + character is used as a path separator on every platform. |
| 101 | + |
| 102 | +**Fulfill** |
| 103 | + * `spec` An object of tech spec about the archive. Properties are: `date`, |
| 104 | + `attr`, `size` and `name`. |
| 105 | + |
| 106 | +**Error** |
| 107 | + * `err` An Error object. |
108 | 108 |
|
109 | 109 |
|
110 | 110 | *** |
|
0 commit comments