Skip to content

Commit aafa8f8

Browse files
author
Leon Aves
committed
Fix jsdoc typings for functions.
1 parent cb300c9 commit aafa8f8

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

adm-zip.js

+20-20
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ var ZipEntry = require("./zipEntry"),
1010
var isWin = /^win/.test(process.platform);
1111

1212

13-
module.exports = function (/*String*/input) {
13+
module.exports = function (/**String*/input) {
1414
var _zip = undefined,
1515
_filename = "";
1616

@@ -39,7 +39,7 @@ module.exports = function (/*String*/input) {
3939
return pth.normalize(pth.join(prefix, pth.basename(name)));
4040
}
4141

42-
function getEntry(/*Object*/entry) {
42+
function getEntry(/**Object*/entry) {
4343
if (entry && _zip) {
4444
var item;
4545
// If entry was given as a file name
@@ -63,7 +63,7 @@ module.exports = function (/*String*/input) {
6363
*
6464
* @return Buffer or Null in case of error
6565
*/
66-
readFile: function (/*Object*/entry) {
66+
readFile: function (/**Object*/entry) {
6767
var item = getEntry(entry);
6868
return item && item.getData() || null;
6969
},
@@ -75,7 +75,7 @@ module.exports = function (/*String*/input) {
7575
*
7676
* @return Buffer or Null in case of error
7777
*/
78-
readFileAsync: function (/*Object*/entry, /*Function*/callback) {
78+
readFileAsync: function (/**Object*/entry, /**Function*/callback) {
7979
var item = getEntry(entry);
8080
if (item) {
8181
item.getDataAsync(callback);
@@ -91,7 +91,7 @@ module.exports = function (/*String*/input) {
9191
*
9292
* @return String
9393
*/
94-
readAsText: function (/*Object*/entry, /*String - Optional*/encoding) {
94+
readAsText: function (/**Object*/entry, /**String=*/encoding) {
9595
var item = getEntry(entry);
9696
if (item) {
9797
var data = item.getData();
@@ -110,7 +110,7 @@ module.exports = function (/*String*/input) {
110110
*
111111
* @return String
112112
*/
113-
readAsTextAsync: function (/*Object*/entry, /*Function*/callback, /*String - Optional*/encoding) {
113+
readAsTextAsync: function (/**Object*/entry, /**Function*/callback, /**String=*/encoding) {
114114
var item = getEntry(entry);
115115
if (item) {
116116
item.getDataAsync(function (data, err) {
@@ -135,7 +135,7 @@ module.exports = function (/*String*/input) {
135135
*
136136
* @param entry
137137
*/
138-
deleteFile: function (/*Object*/entry) { // @TODO: test deleteFile
138+
deleteFile: function (/**Object*/entry) { // @TODO: test deleteFile
139139
var item = getEntry(entry);
140140
if (item) {
141141
_zip.deleteEntry(item.entryName);
@@ -147,7 +147,7 @@ module.exports = function (/*String*/input) {
147147
*
148148
* @param comment
149149
*/
150-
addZipComment: function (/*String*/comment) { // @TODO: test addZipComment
150+
addZipComment: function (/**String*/comment) { // @TODO: test addZipComment
151151
_zip.comment = comment;
152152
},
153153

@@ -167,7 +167,7 @@ module.exports = function (/*String*/input) {
167167
* @param entry
168168
* @param comment
169169
*/
170-
addZipEntryComment: function (/*Object*/entry, /*String*/comment) {
170+
addZipEntryComment: function (/**Object*/entry, /**String*/comment) {
171171
var item = getEntry(entry);
172172
if (item) {
173173
item.comment = comment;
@@ -180,7 +180,7 @@ module.exports = function (/*String*/input) {
180180
* @param entry
181181
* @return String
182182
*/
183-
getZipEntryComment: function (/*Object*/entry) {
183+
getZipEntryComment: function (/**Object*/entry) {
184184
var item = getEntry(entry);
185185
if (item) {
186186
return item.comment || '';
@@ -194,7 +194,7 @@ module.exports = function (/*String*/input) {
194194
* @param entry
195195
* @param content
196196
*/
197-
updateFile: function (/*Object*/entry, /*Buffer*/content) {
197+
updateFile: function (/**Object*/entry, /**Buffer*/content) {
198198
var item = getEntry(entry);
199199
if (item) {
200200
item.setData(content);
@@ -208,7 +208,7 @@ module.exports = function (/*String*/input) {
208208
* @param zipPath Optional path inside the zip
209209
* @param zipName Optional name for the file
210210
*/
211-
addLocalFile: function (/*String*/localPath, /*String*/zipPath, /*String*/zipName) {
211+
addLocalFile: function (/**String*/localPath, /**String=*/zipPath, /**String=*/zipName) {
212212
if (fs.existsSync(localPath)) {
213213
if (zipPath) {
214214
zipPath = zipPath.split("\\").join("/");
@@ -238,7 +238,7 @@ module.exports = function (/*String*/input) {
238238
* @param filter optional RegExp or Function if files match will
239239
* be included.
240240
*/
241-
addLocalFolder: function (/*String*/localPath, /*String*/zipPath, /*RegExp|Function*/filter) {
241+
addLocalFolder: function (/**String*/localPath, /**String=*/zipPath, /**=RegExp|Function*/filter) {
242242
if (filter === undefined) {
243243
filter = function () {
244244
return true;
@@ -297,7 +297,7 @@ module.exports = function (/*String*/input) {
297297
* @param comment
298298
* @param attr
299299
*/
300-
addFile: function (/*String*/entryName, /*Buffer*/content, /*String*/comment, /*Number*/attr) {
300+
addFile: function (/**String*/entryName, /**Buffer*/content, /**String*/comment, /**Number*/attr) {
301301
var entry = new ZipEntry();
302302
entry.entryName = entryName;
303303
entry.comment = comment || "";
@@ -335,7 +335,7 @@ module.exports = function (/*String*/input) {
335335
* @param name
336336
* @return ZipEntry
337337
*/
338-
getEntry: function (/*String*/name) {
338+
getEntry: function (/**String*/name) {
339339
return getEntry(name);
340340
},
341341

@@ -352,7 +352,7 @@ module.exports = function (/*String*/input) {
352352
*
353353
* @return Boolean
354354
*/
355-
extractEntryTo: function (/*Object*/entry, /*String*/targetPath, /*Boolean*/maintainEntryPath, /*Boolean*/overwrite) {
355+
extractEntryTo: function (/**Object*/entry, /**String*/targetPath, /**Boolean*/maintainEntryPath, /**Boolean*/overwrite) {
356356
overwrite = overwrite || false;
357357
maintainEntryPath = typeof maintainEntryPath === "undefined" ? true : maintainEntryPath;
358358

@@ -424,7 +424,7 @@ module.exports = function (/*String*/input) {
424424
* @param overwrite If the file already exists at the target path, the file will be overwriten if this is true.
425425
* Default is FALSE
426426
*/
427-
extractAllTo: function (/*String*/targetPath, /*Boolean*/overwrite) {
427+
extractAllTo: function (/**String*/targetPath, /**Boolean*/overwrite) {
428428
overwrite = overwrite || false;
429429
if (!_zip) {
430430
throw Utils.Errors.NO_ZIP;
@@ -456,7 +456,7 @@ module.exports = function (/*String*/input) {
456456
* Default is FALSE
457457
* @param callback
458458
*/
459-
extractAllToAsync: function (/*String*/targetPath, /*Boolean*/overwrite, /*Function*/callback) {
459+
extractAllToAsync: function (/**String*/targetPath, /**Boolean*/overwrite, /**Function*/callback) {
460460
if (!callback) {
461461
callback = function() {}
462462
}
@@ -516,7 +516,7 @@ module.exports = function (/*String*/input) {
516516
* @param targetFileName
517517
* @param callback
518518
*/
519-
writeZip: function (/*String*/targetFileName, /*Function*/callback) {
519+
writeZip: function (/**String*/targetFileName, /**Function*/callback) {
520520
if (arguments.length === 1) {
521521
if (typeof targetFileName === "function") {
522522
callback = targetFileName;
@@ -541,7 +541,7 @@ module.exports = function (/*String*/input) {
541541
*
542542
* @return Buffer
543543
*/
544-
toBuffer: function (/*Function*/onSuccess, /*Function*/onFail, /*Function*/onItemStart, /*Function*/onItemEnd) {
544+
toBuffer: function (/**Function=*/onSuccess, /**Function=*/onFail, /**Function=*/onItemStart, /**Function=*/onItemEnd) {
545545
this.valueOf = 2;
546546
if (typeof onSuccess === "function") {
547547
_zip.toAsyncBuffer(onSuccess, onFail, onItemStart, onItemEnd);

0 commit comments

Comments
 (0)