legacy-libs/grpc/node_modules/protobufjs/docs/ProtoBuf.Util.html

   1 <!DOCTYPE html>
   2 <html lang="en">
   3 <head>
   4     <meta charset="utf-8">
   5     <title>JSDoc: Namespace: Util</title>
   6
   7     <script src="scripts/prettify/prettify.js"> </script>
   8     <script src="scripts/prettify/lang-css.js"> </script>
   9     <!--[if lt IE 9]>
  10       <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  11     <![endif]-->
  12     <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
  13     <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
  14 </head>
  15
  16 <body>
  17
  18 <div id="main">
  19
  20     <h1 class="page-title">Namespace: Util</h1>
  21
  22
  23
  24
  25
  26
  27 <section>
  28
  29 <header>
  30
  31         <h2>
  32             <span class="ancestors"><a href="ProtoBuf.html">ProtoBuf</a>.</span>
  33
  34         Util
  35         </h2>
  36
  37
  38 </header>
  39
  40 <article>
  41     <div class="container-overview">
  42
  43
  44             <div class="description"><p>ProtoBuf utilities.</p></div>
  45
  46
  47
  48
  49
  50 <dl class="details">
  51
  52
  53
  54
  55
  56
  57
  58
  59
  60
  61
  62
  63
  64
  65
  66
  67
  68
  69
  70
  71
  72
  73
  74
  75
  76
  77     <dt class="tag-source">Source:</dt>
  78     <dd class="tag-source"><ul class="dummy"><li>
  79         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line304">line 304</a>
  80     </li></ul></dd>
  81
  82
  83
  84
  85
  86
  87
  88 </dl>
  89
  90
  91
  92
  93     </div>
  94
  95
  96
  97
  98
  99
 100
 101
 102
 103
 104
 105
 106         <h3 class="subsection-title">Members</h3>
 107
 108
 109
 110 <h4 class="name" id=".IS_NODE"><span class="type-signature">(static, constant) </span>IS_NODE<span class="type-signature"> :boolean</span></h4>
 111
 112
 113
 114
 115 <div class="description">
 116     <p>Flag if running in node or not.</p>
 117 </div>
 118
 119
 120
 121     <h5>Type:</h5>
 122     <ul>
 123         <li>
 124
 125 <span class="param-type">boolean</span>
 126
 127
 128         </li>
 129     </ul>
 130
 131
 132
 133
 134
 135 <dl class="details">
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162     <dt class="tag-source">Source:</dt>
 163     <dd class="tag-source"><ul class="dummy"><li>
 164         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line312">line 312</a>
 165     </li></ul></dd>
 166
 167
 168
 169
 170
 171
 172
 173 </dl>
 174
 175
 176
 177
 178
 179
 180
 181
 182
 183
 184         <h3 class="subsection-title">Methods</h3>
 185
 186
 187
 188
 189
 190
 191     <h4 class="name" id=".fetch"><span class="type-signature">(static) </span>fetch<span class="signature">(path, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {string|undefined}</span></h4>
 192
 193
 194
 195
 196
 197 <div class="description">
 198     <p>Fetches a resource.</p>
 199 </div>
 200
 201
 202
 203
 204
 205
 206
 207
 208
 209     <h5>Parameters:</h5>
 210
 211
 212 <table class="params">
 213     <thead>
 214     <tr>
 215
 216         <th>Name</th>
 217
 218
 219         <th>Type</th>
 220
 221
 222         <th>Attributes</th>
 223
 224
 225
 226
 227         <th class="last">Description</th>
 228     </tr>
 229     </thead>
 230
 231     <tbody>
 232
 233
 234         <tr>
 235
 236                 <td class="name"><code>path</code></td>
 237
 238
 239             <td class="type">
 240
 241
 242 <span class="param-type">string</span>
 243
 244
 245
 246             </td>
 247
 248
 249                 <td class="attributes">
 250
 251
 252
 253
 254
 255                 </td>
 256
 257
 258
 259
 260             <td class="description last"><p>Resource path</p></td>
 261         </tr>
 262
 263
 264
 265         <tr>
 266
 267                 <td class="name"><code>callback</code></td>
 268
 269
 270             <td class="type">
 271
 272
 273 <span class="param-type">function</span>
 274
 275
 276
 277             </td>
 278
 279
 280                 <td class="attributes">
 281
 282                     &lt;optional><br>
 283
 284
 285
 286
 287
 288                 </td>
 289
 290
 291
 292
 293             <td class="description last"><p>Callback receiving the resource's contents. If omitted the resource will
 294   be fetched synchronously. If the request failed, contents will be null.</p></td>
 295         </tr>
 296
 297
 298     </tbody>
 299 </table>
 300
 301
 302
 303
 304
 305
 306 <dl class="details">
 307
 308
 309
 310
 311
 312
 313
 314
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329
 330
 331
 332
 333     <dt class="tag-source">Source:</dt>
 334     <dd class="tag-source"><ul class="dummy"><li>
 335         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line350">line 350</a>
 336     </li></ul></dd>
 337
 338
 339
 340
 341
 342
 343
 344 </dl>
 345
 346
 347
 348
 349
 350
 351
 352
 353
 354
 355
 356
 357
 358 <h5>Returns:</h5>
 359
 360
 361 <div class="param-desc">
 362     <p>Resource contents if callback is omitted (null if the request failed), else undefined.</p>
 363 </div>
 364
 365
 366
 367 <dl>
 368     <dt>
 369         Type
 370     </dt>
 371     <dd>
 372
 373 <span class="param-type">string</span>
 374 |
 375
 376 <span class="param-type">undefined</span>
 377
 378
 379     </dd>
 380 </dl>
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390
 391     <h4 class="name" id=".toCamelCase"><span class="type-signature">(static) </span>toCamelCase<span class="signature">(str)</span><span class="type-signature"> &rarr; {string}</span></h4>
 392
 393
 394
 395
 396
 397 <div class="description">
 398     <p>Converts a string to camel case.</p>
 399 </div>
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409     <h5>Parameters:</h5>
 410
 411
 412 <table class="params">
 413     <thead>
 414     <tr>
 415
 416         <th>Name</th>
 417
 418
 419         <th>Type</th>
 420
 421
 422
 423
 424
 425         <th class="last">Description</th>
 426     </tr>
 427     </thead>
 428
 429     <tbody>
 430
 431
 432         <tr>
 433
 434                 <td class="name"><code>str</code></td>
 435
 436
 437             <td class="type">
 438
 439
 440 <span class="param-type">string</span>
 441
 442
 443
 444             </td>
 445
 446
 447
 448
 449
 450             <td class="description last"></td>
 451         </tr>
 452
 453
 454     </tbody>
 455 </table>
 456
 457
 458
 459
 460
 461
 462 <dl class="details">
 463
 464
 465
 466
 467
 468
 469
 470
 471
 472
 473
 474
 475
 476
 477
 478
 479
 480
 481
 482
 483
 484
 485
 486
 487
 488
 489     <dt class="tag-source">Source:</dt>
 490     <dd class="tag-source"><ul class="dummy"><li>
 491         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line400">line 400</a>
 492     </li></ul></dd>
 493
 494
 495
 496
 497
 498
 499
 500 </dl>
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510
 511
 512
 513
 514 <h5>Returns:</h5>
 515
 516
 517
 518
 519 <dl>
 520     <dt>
 521         Type
 522     </dt>
 523     <dd>
 524
 525 <span class="param-type">string</span>
 526
 527
 528     </dd>
 529 </dl>
 530
 531
 532
 533
 534
 535
 536
 537
 538
 539
 540     <h4 class="name" id=".XHR"><span class="type-signature">(static) </span>XHR<span class="signature">()</span><span class="type-signature"> &rarr; {XMLHttpRequest}</span></h4>
 541
 542
 543
 544
 545
 546 <div class="description">
 547     <p>Constructs a XMLHttpRequest object.</p>
 548 </div>
 549
 550
 551
 552
 553
 554
 555
 556
 557
 558
 559
 560
 561
 562 <dl class="details">
 563
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587
 588
 589     <dt class="tag-source">Source:</dt>
 590     <dd class="tag-source"><ul class="dummy"><li>
 591         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line322">line 322</a>
 592     </li></ul></dd>
 593
 594
 595
 596
 597
 598
 599
 600 </dl>
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610
 611
 612 <h5>Throws:</h5>
 613
 614
 615
 616 <dl>
 617     <dt>
 618         <div class="param-desc">
 619         <p>If XMLHttpRequest is not supported</p>
 620         </div>
 621     </dt>
 622     <dd></dd>
 623     <dt>
 624         <dl>
 625             <dt>
 626                 Type
 627             </dt>
 628             <dd>
 629
 630 <span class="param-type">Error</span>
 631
 632
 633             </dd>
 634         </dl>
 635     </dt>
 636     <dd></dd>
 637 </dl>
 638
 639
 640
 641
 642
 643 <h5>Returns:</h5>
 644
 645
 646
 647
 648 <dl>
 649     <dt>
 650         Type
 651     </dt>
 652     <dd>
 653
 654 <span class="param-type">XMLHttpRequest</span>
 655
 656
 657     </dd>
 658 </dl>
 659
 660
 661
 662
 663
 664
 665
 666
 667
 668
 669
 670 </article>
 671
 672 </section>
 673
 674
 675
 676
 677 </div>
 678
 679 <nav>
 680     <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="ProtoBuf.Builder.html">Builder</a></li><li><a href="ProtoBuf.Builder.Message.html">Message</a></li><li><a href="ProtoBuf.Builder.Service.html">Service</a></li><li><a href="ProtoBuf.DotProto.Parser.html">Parser</a></li><li><a href="ProtoBuf.DotProto.Tokenizer.html">Tokenizer</a></li><li><a href="ProtoBuf.Map.html">Map</a></li><li><a href="ProtoBuf.Reflect.Element.html">Element</a></li><li><a href="ProtoBuf.Reflect.Enum.html">Enum</a></li><li><a href="ProtoBuf.Reflect.Enum.Value.html">Value</a></li><li><a href="ProtoBuf.Reflect.Extension.html">Extension</a></li><li><a href="ProtoBuf.Reflect.Message.html">Message</a></li><li><a href="ProtoBuf.Reflect.Message.ExtensionField.html">ExtensionField</a></li><li><a href="ProtoBuf.Reflect.Message.Field.html">Field</a></li><li><a href="ProtoBuf.Reflect.Message.OneOf.html">OneOf</a></li><li><a href="ProtoBuf.Reflect.Namespace.html">Namespace</a></li><li><a href="ProtoBuf.Reflect.Service.html">Service</a></li><li><a href="ProtoBuf.Reflect.Service.Method.html">Method</a></li><li><a href="ProtoBuf.Reflect.Service.RPCMethod.html">RPCMethod</a></li><li><a href="ProtoBuf.Reflect.T.html">T</a></li></ul><h3>Namespaces</h3><ul><li><a href="ProtoBuf.html">ProtoBuf</a></li><li><a href="ProtoBuf.DotProto.html">DotProto</a></li><li><a href="ProtoBuf.Reflect.html">Reflect</a></li><li><a href="ProtoBuf.Util.html">Util</a></li></ul>
 681 </nav>
 682
 683 <br class="clear">
 684
 685 <footer>
 686     Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.3</a> on Fri Jan 27 2017 17:03:55 GMT+0100 (Mitteleuropäische Zeit)
 687 </footer>
 688
 689 <script> prettyPrint(); </script>
 690 <script src="scripts/linenumber.js"> </script>
 691 </body>
 692 </html>