legacy-libs/grpc/node_modules/protobufjs/externs/fs.js

   1 /*\r
   2  * Copyright 2012 The Closure Compiler Authors.\r
   3  *\r
   4  * Licensed under the Apache License, Version 2.0 (the "License");\r
   5  * you may not use this file except in compliance with the License.\r
   6  * You may obtain a copy of the License at\r
   7  *\r
   8  *     http://www.apache.org/licenses/LICENSE-2.0\r
   9  *\r
  10  * Unless required by applicable law or agreed to in writing, software\r
  11  * distributed under the License is distributed on an "AS IS" BASIS,\r
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  13  * See the License for the specific language governing permissions and\r
  14  * limitations under the License.\r
  15  */\r
  16 \r
  17 /**\r
  18  * @fileoverview Definitions for node's "fs" module.\r
  19  * @see http://nodejs.org/api/fs.html\r
  20  * @externs\r
  21  * @author Daniel Wirtz <dcode@dcode.io>\r
  22  */\r
  23 \r
  24 /**\r
  25  BEGIN_NODE_INCLUDE\r
  26  var fs = require('fs');\r
  27  END_NODE_INCLUDE\r
  28  */\r
  29 \r
  30 var fs = {};\r
  31 \r
  32 /**\r
  33  * @param {string} oldPath\r
  34  * @param {string} newPath\r
  35  * @param {function(...)=} callback\r
  36  */\r
  37 fs.rename = function(oldPath, newPath, callback) {};\r
  38 \r
  39 /**\r
  40  * @param {string} oldPath\r
  41  * @param {string} newPath\r
  42  */\r
  43 fs.renameSync = function(oldPath, newPath) {};\r
  44 \r
  45 /**\r
  46  * @param {*} fd\r
  47  * @param {number} len\r
  48  * @param {function(...)=} callback\r
  49  */\r
  50 fs.truncate = function(fd, len, callback) {};\r
  51 \r
  52 /**\r
  53  * @param {*} fd\r
  54  * @param {number} len\r
  55  */\r
  56 fs.truncateSync = function(fd, len) {};\r
  57 \r
  58 /**\r
  59  * @param {string} path\r
  60  * @param {number} uid\r
  61  * @param {number} gid\r
  62  * @param {function(...)=} callback\r
  63  */\r
  64 fs.chown = function(path, uid, gid, callback) {};\r
  65 \r
  66 /**\r
  67  * @param {string} path\r
  68  * @param {number} uid\r
  69  * @param {number} gid\r
  70  */\r
  71 fs.chownSync = function(path, uid, gid) {};\r
  72 \r
  73 /**\r
  74  * @param {*} fd\r
  75  * @param {number} uid\r
  76  * @param {number} gid\r
  77  * @param {function(...)=} callback\r
  78  */\r
  79 fs.fchown = function(fd, uid, gid, callback) {};\r
  80 \r
  81 /**\r
  82  * @param {*} fd\r
  83  * @param {number} uid\r
  84  * @param {number} gid\r
  85  */\r
  86 fs.fchownSync = function(fd, uid, gid) {};\r
  87 \r
  88 /**\r
  89  * @param {string} path\r
  90  * @param {number} uid\r
  91  * @param {number} gid\r
  92  * @param {function(...)=} callback\r
  93  */\r
  94 fs.lchown = function(path, uid, gid, callback) {};\r
  95 \r
  96 /**\r
  97  * @param {string} path\r
  98  * @param {number} uid\r
  99  * @param {number} gid\r
 100  */\r
 101 fs.lchownSync = function(path, uid, gid) {};\r
 102 \r
 103 /**\r
 104  * @param {string} path\r
 105  * @param {number} mode\r
 106  * @param {function(...)=} callback\r
 107  */\r
 108 fs.chmod = function(path, mode, callback) {};\r
 109 \r
 110 /**\r
 111  * @param {string} path\r
 112  * @param {number} mode\r
 113  */\r
 114 fs.chmodSync = function(path, mode) {};\r
 115 \r
 116 /**\r
 117  * @param {*} fd\r
 118  * @param {number} mode\r
 119  * @param {function(...)=} callback\r
 120  */\r
 121 fs.fchmod = function(fd, mode, callback) {};\r
 122 \r
 123 /**\r
 124  * @param {*} fd\r
 125  * @param {number} mode\r
 126  */\r
 127 fs.fchmodSync = function(fd, mode) {};\r
 128 \r
 129 /**\r
 130  * @param {string} path\r
 131  * @param {number} mode\r
 132  * @param {function(...)=} callback\r
 133  */\r
 134 fs.lchmod = function(path, mode, callback) {};\r
 135 \r
 136 /**\r
 137  * @param {string} path\r
 138  * @param {number} mode\r
 139  */\r
 140 fs.lchmodSync = function(path, mode) {};\r
 141 \r
 142 /**\r
 143  * @param {string} path\r
 144  * @param {function(string, fs.Stats)=} callback\r
 145  * @nosideeffects\r
 146  */\r
 147 fs.stat = function(path, callback) {};\r
 148 \r
 149 /**\r
 150  * @param {string} path\r
 151  * @return {fs.Stats}\r
 152  * @nosideeffects\r
 153  */\r
 154 fs.statSync = function(path) {}\r
 155 \r
 156 /**\r
 157  * @param {*} fd\r
 158  * @param {function(string, fs.Stats)=} callback\r
 159  * @nosideeffects\r
 160  */\r
 161 fs.fstat = function(fd, callback) {};\r
 162 \r
 163 /**\r
 164  * @param {*} fd\r
 165  * @return {fs.Stats}\r
 166  * @nosideeffects\r
 167  */\r
 168 fs.fstatSync = function(fd) {}\r
 169 \r
 170 /**\r
 171  * @param {string} path\r
 172  * @param {function(string, fs.Stats)=} callback\r
 173  * @nosideeffects\r
 174  */\r
 175 fs.lstat = function(path, callback) {};\r
 176 \r
 177 /**\r
 178  * @param {string} path\r
 179  * @return {fs.Stats}\r
 180  * @nosideeffects\r
 181  */\r
 182 fs.lstatSync = function(path) {}\r
 183 \r
 184 /**\r
 185  * @param {string} srcpath\r
 186  * @param {string} dstpath\r
 187  * @param {function(...)=} callback\r
 188  */\r
 189 fs.link = function(srcpath, dstpath, callback) {};\r
 190 \r
 191 /**\r
 192  * @param {string} srcpath\r
 193  * @param {string} dstpath\r
 194  */\r
 195 fs.linkSync = function(srcpath, dstpath) {};\r
 196 \r
 197 /**\r
 198  * @param {string} srcpath\r
 199  * @param {string} dstpath\r
 200  * @param {string=} type\r
 201  * @param {function(...)=} callback\r
 202  */\r
 203 fs.symlink = function(srcpath, dstpath, type, callback) {};\r
 204 \r
 205 /**\r
 206  * @param {string} srcpath\r
 207  * @param {string} dstpath\r
 208  * @param {string=} type\r
 209  */\r
 210 fs.symlinkSync = function(srcpath, dstpath, type) {};\r
 211 \r
 212 /**\r
 213  * @param {string} path\r
 214  * @param {function(string, string)=} callback\r
 215  * @nosideeffects\r
 216  */\r
 217 fs.readlink = function(path, callback) {};\r
 218 \r
 219 /**\r
 220  * @param {string} path\r
 221  * @return {string}\r
 222  * @nosideeffects\r
 223  */\r
 224 fs.readlinkSync = function(path) {};\r
 225 \r
 226 /**\r
 227  * @param {string} path\r
 228  * @param {object.<string,string>=|function(string, string)=} cache\r
 229  * @param {function(string, string)=} callback\r
 230  * @nosideeffects\r
 231  */\r
 232 fs.realpath = function(path, cache, callback) {};\r
 233 \r
 234 /**\r
 235  * @param {string} path\r
 236  * @param {object.<string,string>=} cache\r
 237  * @return {string}\r
 238  * @nosideeffects\r
 239  */\r
 240 fs.realpathSync = function(path, cache) {};\r
 241 \r
 242 /**\r
 243  * @param {string} path\r
 244  * @param {function(...)=} callback\r
 245  */\r
 246 fs.unlink = function(path, callback) {};\r
 247 \r
 248 /**\r
 249  * @param {string} path\r
 250  */\r
 251 fs.unlinkSync = function(path) {};\r
 252 \r
 253 /**\r
 254  * @param {string} path\r
 255  * @param {function(...)=} callback\r
 256  */\r
 257 fs.rmdir = function(path, callback) {};\r
 258 \r
 259 /**\r
 260  * @param {string} path\r
 261  */\r
 262 fs.rmdirSync = function(path) {};\r
 263 \r
 264 /**\r
 265  * @param {string} path\r
 266  * @param {number=} mode\r
 267  * @param {function(...)=} callback\r
 268  */\r
 269 fs.mkdir = function(path, mode, callback) {};\r
 270 \r
 271 /**\r
 272  * @param {string} path\r
 273  * @param {number=} mode\r
 274  */\r
 275 fs.mkdirSync = function(path, mode) {};\r
 276 \r
 277 /**\r
 278  * @param {string} path\r
 279  * @param {function(string,array.<string>)=} callback\r
 280  * @nosideeffects\r
 281  */\r
 282 fs.readdir = function(path, callback) {};\r
 283 \r
 284 /**\r
 285  * @param {string} path\r
 286  * @return {array.<string>}\r
 287  * @nosideeffects\r
 288  */\r
 289 fs.readdirSync = function(path) {};\r
 290 \r
 291 /**\r
 292  * @param {*} fd\r
 293  * @param {function(...)=} callback\r
 294  */\r
 295 fs.close = function(fd, callback) {};\r
 296 \r
 297 /**\r
 298  * @param {*} fd\r
 299  */\r
 300 fs.closeSync = function(fd) {};\r
 301 \r
 302 /**\r
 303  * @param {string} path\r
 304  * @param {string} flags\r
 305  * @param {number=} mode\r
 306  * @param {function(string, *)=} callback\r
 307  * @nosideeffects\r
 308  */\r
 309 fs.open = function(path, flags, mode, callback) {};\r
 310 \r
 311 /**\r
 312  * @param {string} path\r
 313  * @param {string} flags\r
 314  * @param {number=} mode\r
 315  * @return {*}\r
 316  * @nosideeffects\r
 317  */\r
 318 fs.openSync = function(path, flags, mode) {};\r
 319 \r
 320 /**\r
 321  * @param {string} path\r
 322  * @param {number} atime\r
 323  * @param {number} mtime\r
 324  * @param {function(...)=} callback\r
 325  * @nosideeffects\r
 326  */\r
 327 fs.utimes = function(path, atime, mtime, callback) {};\r
 328 \r
 329 /**\r
 330  * @param {string} path\r
 331  * @param {number} atime\r
 332  * @param {number} mtime\r
 333  * @nosideeffects\r
 334  */\r
 335 fs.utimesSync = function(path, atime, mtime) {};\r
 336 \r
 337 /**\r
 338  * @param {*} fd\r
 339  * @param {number} atime\r
 340  * @param {number} mtime\r
 341  * @param {function(...)=} callback\r
 342  * @nosideeffects\r
 343  */\r
 344 fs.futimes = function(fd, atime, mtime, callback) {};\r
 345 \r
 346 /**\r
 347  * @param {*} fd\r
 348  * @param {number} atime\r
 349  * @param {number} mtime\r
 350  * @nosideeffects\r
 351  */\r
 352 fs.futimesSync = function(fd, atime, mtime) {};\r
 353 \r
 354 /**\r
 355  * @param {*} fd\r
 356  * @param {function(...)=} callback\r
 357  */\r
 358 fs.fsync = function(fd, callback) {};\r
 359 \r
 360 /**\r
 361  * @param {*} fd\r
 362  */\r
 363 fs.fsyncSync = function(fd) {};\r
 364 \r
 365 /**\r
 366  * @param {*} fd\r
 367  * @param {*} buffer\r
 368  * @param {number} offset\r
 369  * @param {number} length\r
 370  * @param {number} position\r
 371  * @param {function(string, number, *)=} callback\r
 372  */\r
 373 fs.write = function(fd, buffer, offset, length, position, callback) {};\r
 374 \r
 375 /**\r
 376  * @param {*} fd\r
 377  * @param {*} buffer\r
 378  * @param {number} offset\r
 379  * @param {number} length\r
 380  * @param {number} position\r
 381  * @return {number}\r
 382  */\r
 383 fs.writeSync = function(fd, buffer, offset, length, position) {};\r
 384 \r
 385 /**\r
 386  * @param {*} fd\r
 387  * @param {*} buffer\r
 388  * @param {number} offset\r
 389  * @param {number} length\r
 390  * @param {number} position\r
 391  * @param {function(string, number, *)=} callback\r
 392  * @nosideeffects\r
 393  */\r
 394 fs.read = function(fd, buffer, offset, length, position, callback) {};\r
 395 \r
 396 /**\r
 397  * @param {*} fd\r
 398  * @param {*} buffer\r
 399  * @param {number} offset\r
 400  * @param {number} length\r
 401  * @param {number} position\r
 402  * @return {number}\r
 403  * @nosideeffects\r
 404  */\r
 405 fs.readSync = function(fd, buffer, offset, length, position) {};\r
 406 \r
 407 /**\r
 408  * @param {string} filename\r
 409  * @param {string=|function(string, *)=}encoding\r
 410  * @param {function(string, *)=} callback\r
 411  * @nosideeffects\r
 412  */\r
 413 fs.readFile = function(filename, encoding, callback) {};\r
 414 \r
 415 /**\r
 416  * @param {string} filename\r
 417  * @param {string=} encoding\r
 418  * @nosideeffects\r
 419  */\r
 420 fs.readFileSync = function(filename, encoding) {};\r
 421 \r
 422 /**\r
 423  * @param {string} filename\r
 424  * @param {*} data\r
 425  * @param {string=|function(string)=} encoding\r
 426  * @param {function(string)=} callback\r
 427  */\r
 428 fs.writeFile = function(filename, data, encoding, callback) {};\r
 429 \r
 430 /**\r
 431  * @param {string} filename\r
 432  * @param {*} data\r
 433  * @param {string=} encoding\r
 434  */\r
 435 fs.writeFileSync = function(filename, data, encoding) {};\r
 436 \r
 437 /**\r
 438  * @param {string} filename\r
 439  * @param {*} data\r
 440  * @param {string=|function(string)=} encoding\r
 441  * @param {function(string)=} callback\r
 442  */\r
 443 fs.appendFile = function(filename, data, encoding, callback) {};\r
 444 \r
 445 /**\r
 446  * @param {string} filename\r
 447  * @param {*} data\r
 448  * @param {string=|function(string)=} encoding\r
 449  */\r
 450 fs.appendFileSync = function(filename, data, encoding) {};\r
 451 \r
 452 /**\r
 453  * @param {string} filename\r
 454  * @param {{persistent: boolean, interval: number}=|function(*,*)} options\r
 455  * @param {function(*,*)=} listener\r
 456  */\r
 457 fs.watchFile = function(filename, options, listener) {};\r
 458 \r
 459 /**\r
 460  * @param {string} filename\r
 461  * @param {function=} listener\r
 462  */\r
 463 fs.unwatchFile = function(filename, listener) {};\r
 464 \r
 465 /**\r
 466  * \r
 467  * @param {string} filename\r
 468  * @param {{persistent: boolean}=|function(string, string)} options\r
 469  * @param {function(string, string)=} listener\r
 470  * @return {fs.FSWatcher}\r
 471  */\r
 472 fs.watch = function(filename, options, listener) {};\r
 473 \r
 474 /**\r
 475  * @param {string} path\r
 476  * @param {function(boolean)} callback\r
 477  * @nosideeffects\r
 478  */\r
 479 fs.exists = function(path, callback) {};\r
 480 \r
 481 /**\r
 482  * @param {string} path\r
 483  * @nosideeffects\r
 484  */\r
 485 fs.existsSync = function(path) {};\r
 486 \r
 487 /**\r
 488  * @constructor\r
 489  */\r
 490 fs.Stats = function() {};\r
 491 \r
 492 /**\r
 493  * @return {boolean}\r
 494  * @nosideeffects\r
 495  */\r
 496 fs.Stats.prototype.isFile = function() {};\r
 497 \r
 498 /**\r
 499  * @return {boolean}\r
 500  * @nosideeffects\r
 501  */\r
 502 fs.Stats.prototype.isDirectory = function() {};\r
 503 \r
 504 /**\r
 505  * @return {boolean}\r
 506  * @nosideeffects\r
 507  */\r
 508 fs.Stats.prototype.isBlockDevice = function() {};\r
 509 \r
 510 /**\r
 511  * @return {boolean}\r
 512  * @nosideeffects\r
 513  */\r
 514 fs.Stats.prototype.isCharacterDevice = function() {};\r
 515 \r
 516 /**\r
 517  * @return {boolean}\r
 518  * @nosideeffects\r
 519  */\r
 520 fs.Stats.prototype.isSymbolicLink = function() {};\r
 521 \r
 522 /**\r
 523  * @return {boolean}\r
 524  * @nosideeffects\r
 525  */\r
 526 fs.Stats.prototype.isFIFO = function() {};\r
 527 \r
 528 /**\r
 529  * @return {boolean}\r
 530  * @nosideeffects\r
 531  */\r
 532 fs.Stats.prototype.isSocket = function() {};\r
 533 \r
 534 /**\r
 535  * @type {number}\r
 536  */\r
 537 fs.Stats.prototype.dev = 0;\r
 538 \r
 539 /**\r
 540  * @type {number}\r
 541  */\r
 542 fs.Stats.prototype.ino = 0;\r
 543 \r
 544 /**\r
 545  * @type {number}\r
 546  */\r
 547 fs.Stats.prototype.mode = 0;\r
 548 \r
 549 /**\r
 550  * @type {number}\r
 551  */\r
 552 fs.Stats.prototype.nlink = 0;\r
 553 \r
 554 /**\r
 555  * @type {number}\r
 556  */\r
 557 fs.Stats.prototype.uid = 0;\r
 558 \r
 559 /**\r
 560  * @type {number}\r
 561  */\r
 562 fs.Stats.prototype.gid = 0;\r
 563 \r
 564 /**\r
 565  * @type {number}\r
 566  */\r
 567 fs.Stats.prototype.rdev = 0;\r
 568 \r
 569 /**\r
 570  * @type {number}\r
 571  */\r
 572 fs.Stats.prototype.size = 0;\r
 573 \r
 574 /**\r
 575  * @type {number}\r
 576  */\r
 577 fs.Stats.prototype.blkSize = 0;\r
 578 \r
 579 /**\r
 580  * @type {number}\r
 581  */\r
 582 fs.Stats.prototype.blocks = 0;\r
 583 \r
 584 /**\r
 585  * @type {Date}\r
 586  */\r
 587 fs.Stats.prototype.atime = 0;\r
 588 \r
 589 /**\r
 590  * @type {Date}\r
 591  */\r
 592 fs.Stats.prototype.mtime = 0;\r
 593 \r
 594 /**\r
 595  * @type {Date}\r
 596  */\r
 597 fs.Stats.prototype.ctime = 0;\r
 598 \r
 599 /**\r
 600  * @param {string} path\r
 601  * @param {{flags: string, encoding: ?string, fd: *, mode: number, bufferSize: number}=} options\r
 602  * @nosideeffects\r
 603  */\r
 604 fs.createReadStream = function(path, options) {};\r
 605 \r
 606 /**\r
 607  * @constructor\r
 608  * @extends {stream.ReadableStream}\r
 609  */\r
 610 fs.ReadStream = function() {};\r
 611 \r
 612 /**\r
 613  * @param {string} path\r
 614  * @param {{flags: string, encoding: ?string, mode: number}=} options\r
 615  * @nosideeffects\r
 616  */\r
 617 fs.createWriteStream = function(path, options) {};\r
 618 \r
 619 /**\r
 620  * @constructor\r
 621  * @extends {stream.WritableStream}\r
 622  */\r
 623 fs.WriteStream = function() {};\r
 624 \r
 625 /**\r
 626  * @param {string} event\r
 627  * @param {function(...)} callback\r
 628  */\r
 629 fs.WriteStream.prototype.on = function(event, callback) {};\r
 630 \r
 631 /**\r
 632  * @constructor\r
 633  */\r
 634 fs.FSWatcher = function() {};\r
 635 \r
 636 /**\r
 637  */\r
 638 fs.FSWatcher.prototype.close = function() {};\r
 639 \r
 640 /**\r
 641  * @param {string} event\r
 642  * @param {function(...)} callback\r
 643  */\r
 644 fs.FSWatcher.prototype.on = function(event, callback) {};\r