legacy-libs/grpc/node_modules/protobufjs/docs/ProtoBuf.DotProto.Parser.html

   1 <!DOCTYPE html>
   2 <html lang="en">
   3 <head>
   4     <meta charset="utf-8">
   5     <title>JSDoc: Class: Parser</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">Class: Parser</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><a href="ProtoBuf.DotProto.html">.DotProto</a>.</span>
  33
  34         Parser
  35         </h2>
  36
  37             <div class="class-description"><p>prototype parser</p></div>
  38
  39
  40 </header>
  41
  42 <article>
  43     <div class="container-overview">
  44
  45
  46
  47
  48     <h2>Constructor</h2>
  49
  50
  51     <h4 class="name" id="Parser"><span class="type-signature"></span>new Parser<span class="signature">(source)</span><span class="type-signature"></span></h4>
  52
  53
  54
  55
  56
  57 <div class="description">
  58     <p>Constructs a new Parser.</p>
  59 </div>
  60
  61
  62
  63
  64
  65
  66
  67
  68
  69     <h5>Parameters:</h5>
  70
  71
  72 <table class="params">
  73     <thead>
  74     <tr>
  75
  76         <th>Name</th>
  77
  78
  79         <th>Type</th>
  80
  81
  82
  83
  84
  85         <th class="last">Description</th>
  86     </tr>
  87     </thead>
  88
  89     <tbody>
  90
  91
  92         <tr>
  93
  94                 <td class="name"><code>source</code></td>
  95
  96
  97             <td class="type">
  98
  99
 100 <span class="param-type">string</span>
 101
 102
 103
 104             </td>
 105
 106
 107
 108
 109
 110             <td class="description last"><p>Source</p></td>
 111         </tr>
 112
 113
 114     </tbody>
 115 </table>
 116
 117
 118
 119
 120
 121
 122 <dl class="details">
 123
 124
 125
 126
 127
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149     <dt class="tag-source">Source:</dt>
 150     <dd class="tag-source"><ul class="dummy"><li>
 151         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line688">line 688</a>
 152     </li></ul></dd>
 153
 154
 155
 156
 157
 158
 159
 160 </dl>
 161
 162
 163
 164
 165
 166
 167
 168
 169
 170
 171
 172
 173
 174
 175
 176
 177
 178     </div>
 179
 180
 181
 182
 183
 184
 185
 186
 187
 188
 189
 190
 191         <h3 class="subsection-title">Members</h3>
 192
 193
 194
 195 <h4 class="name" id="proto3"><span class="type-signature"></span>proto3<span class="type-signature"> :boolean</span></h4>
 196
 197
 198
 199
 200 <div class="description">
 201     <p>Whether parsing proto3 or not.</p>
 202 </div>
 203
 204
 205
 206     <h5>Type:</h5>
 207     <ul>
 208         <li>
 209
 210 <span class="param-type">boolean</span>
 211
 212
 213         </li>
 214     </ul>
 215
 216
 217
 218
 219
 220 <dl class="details">
 221
 222
 223
 224
 225
 226
 227
 228
 229
 230
 231
 232
 233
 234
 235
 236
 237
 238
 239
 240
 241
 242
 243
 244
 245
 246
 247     <dt class="tag-source">Source:</dt>
 248     <dd class="tag-source"><ul class="dummy"><li>
 249         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line701">line 701</a>
 250     </li></ul></dd>
 251
 252
 253
 254
 255
 256
 257
 258 </dl>
 259
 260
 261
 262
 263
 264
 265
 266
 267 <h4 class="name" id="tn"><span class="type-signature">(non-null) </span>tn<span class="type-signature"> :<a href="ProtoBuf.DotProto.Tokenizer.html">ProtoBuf.DotProto.Tokenizer</a></span></h4>
 268
 269
 270
 271
 272 <div class="description">
 273     <p>Tokenizer.</p>
 274 </div>
 275
 276
 277
 278     <h5>Type:</h5>
 279     <ul>
 280         <li>
 281
 282 <span class="param-type"><a href="ProtoBuf.DotProto.Tokenizer.html">ProtoBuf.DotProto.Tokenizer</a></span>
 283
 284
 285         </li>
 286     </ul>
 287
 288
 289
 290
 291
 292 <dl class="details">
 293
 294
 295
 296
 297
 298
 299
 300
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310
 311
 312
 313
 314
 315
 316
 317
 318
 319     <dt class="tag-source">Source:</dt>
 320     <dd class="tag-source"><ul class="dummy"><li>
 321         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line695">line 695</a>
 322     </li></ul></dd>
 323
 324
 325
 326
 327
 328
 329
 330 </dl>
 331
 332
 333
 334
 335
 336
 337
 338
 339
 340
 341         <h3 class="subsection-title">Methods</h3>
 342
 343
 344
 345
 346
 347
 348     <h4 class="name" id=".parse"><span class="type-signature">(static) </span>parse<span class="signature">()</span><span class="type-signature"> &rarr; (non-null) {Object}</span></h4>
 349
 350
 351
 352
 353
 354 <div class="description">
 355     <p>Parses the specified source.</p>
 356 </div>
 357
 358
 359
 360
 361
 362
 363
 364
 365
 366
 367
 368
 369
 370 <dl class="details">
 371
 372
 373
 374
 375
 376
 377
 378
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392
 393
 394
 395
 396
 397     <dt class="tag-source">Source:</dt>
 398     <dd class="tag-source"><ul class="dummy"><li>
 399         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line796">line 796</a>
 400     </li></ul></dd>
 401
 402
 403
 404
 405
 406
 407
 408 </dl>
 409
 410
 411
 412
 413
 414
 415
 416
 417
 418
 419
 420 <h5>Throws:</h5>
 421
 422
 423
 424 <dl>
 425     <dt>
 426         <div class="param-desc">
 427         <p>If the source cannot be parsed</p>
 428         </div>
 429     </dt>
 430     <dd></dd>
 431     <dt>
 432         <dl>
 433             <dt>
 434                 Type
 435             </dt>
 436             <dd>
 437
 438 <span class="param-type">Error</span>
 439
 440
 441             </dd>
 442         </dl>
 443     </dt>
 444     <dd></dd>
 445 </dl>
 446
 447
 448
 449
 450
 451 <h5>Returns:</h5>
 452
 453
 454
 455
 456 <dl>
 457     <dt>
 458         Type
 459     </dt>
 460     <dd>
 461
 462 <span class="param-type">Object</span>
 463
 464
 465     </dd>
 466 </dl>
 467
 468
 469
 470
 471
 472
 473
 474
 475
 476
 477     <h4 class="name" id="parse"><span class="type-signature"></span>parse<span class="signature">()</span><span class="type-signature"> &rarr; (non-null) {Object}</span></h4>
 478
 479
 480
 481
 482
 483 <div class="description">
 484     <p>Parses the source.</p>
 485 </div>
 486
 487
 488
 489
 490
 491
 492
 493
 494
 495
 496
 497
 498
 499 <dl class="details">
 500
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510
 511
 512
 513
 514
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524
 525
 526     <dt class="tag-source">Source:</dt>
 527     <dd class="tag-source"><ul class="dummy"><li>
 528         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line716">line 716</a>
 529     </li></ul></dd>
 530
 531
 532
 533
 534
 535
 536
 537 </dl>
 538
 539
 540
 541
 542
 543
 544
 545
 546
 547
 548
 549 <h5>Throws:</h5>
 550
 551
 552
 553 <dl>
 554     <dt>
 555         <div class="param-desc">
 556         <p>If the source cannot be parsed</p>
 557         </div>
 558     </dt>
 559     <dd></dd>
 560     <dt>
 561         <dl>
 562             <dt>
 563                 Type
 564             </dt>
 565             <dd>
 566
 567 <span class="param-type">Error</span>
 568
 569
 570             </dd>
 571         </dl>
 572     </dt>
 573     <dd></dd>
 574 </dl>
 575
 576
 577
 578
 579
 580 <h5>Returns:</h5>
 581
 582
 583
 584
 585 <dl>
 586     <dt>
 587         Type
 588     </dt>
 589     <dd>
 590
 591 <span class="param-type">Object</span>
 592
 593
 594     </dd>
 595 </dl>
 596
 597
 598
 599
 600
 601
 602
 603
 604
 605
 606     <h4 class="name" id="toString"><span class="type-signature"></span>toString<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
 607
 608
 609
 610
 611
 612 <div class="description">
 613     <p>Returns a string representation of this parser.</p>
 614 </div>
 615
 616
 617
 618
 619
 620
 621
 622
 623
 624
 625
 626
 627
 628 <dl class="details">
 629
 630
 631
 632
 633
 634
 635
 636
 637
 638
 639
 640
 641
 642
 643
 644
 645
 646
 647
 648
 649
 650
 651
 652
 653
 654
 655     <dt class="tag-source">Source:</dt>
 656     <dd class="tag-source"><ul class="dummy"><li>
 657         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1373">line 1373</a>
 658     </li></ul></dd>
 659
 660
 661
 662
 663
 664
 665
 666 </dl>
 667
 668
 669
 670
 671
 672
 673
 674
 675
 676
 677
 678
 679
 680 <h5>Returns:</h5>
 681
 682
 683
 684
 685 <dl>
 686     <dt>
 687         Type
 688     </dt>
 689     <dd>
 690
 691 <span class="param-type">string</span>
 692
 693
 694     </dd>
 695 </dl>
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705
 706
 707 </article>
 708
 709 </section>
 710
 711
 712
 713
 714 </div>
 715
 716 <nav>
 717     <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>
 718 </nav>
 719
 720 <br class="clear">
 721
 722 <footer>
 723     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)
 724 </footer>
 725
 726 <script> prettyPrint(); </script>
 727 <script src="scripts/linenumber.js"> </script>
 728 </body>
 729 </html>