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

   1 <!DOCTYPE html>
   2 <html lang="en">
   3 <head>
   4     <meta charset="utf-8">
   5     <title>JSDoc: Class: Builder</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: Builder</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         Builder
  35         </h2>
  36
  37             <div class="class-description"><p>Provides the functionality to build protocol messages.</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="Builder"><span class="type-signature"></span>new Builder<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
  52
  53
  54
  55
  56
  57 <div class="description">
  58     <p>Constructs a new Builder.</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         <th>Attributes</th>
  83
  84
  85
  86
  87         <th class="last">Description</th>
  88     </tr>
  89     </thead>
  90
  91     <tbody>
  92
  93
  94         <tr>
  95
  96                 <td class="name"><code>options</code></td>
  97
  98
  99             <td class="type">
 100
 101
 102 <span class="param-type">Object.&lt;string, *></span>
 103
 104
 105
 106             </td>
 107
 108
 109                 <td class="attributes">
 110
 111                     &lt;optional><br>
 112
 113
 114
 115
 116
 117                 </td>
 118
 119
 120
 121
 122             <td class="description last"><p>Options</p></td>
 123         </tr>
 124
 125
 126     </tbody>
 127 </table>
 128
 129
 130
 131
 132
 133
 134 <dl class="details">
 135
 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     <dt class="tag-source">Source:</dt>
 162     <dd class="tag-source"><ul class="dummy"><li>
 163         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4295">line 4295</a>
 164     </li></ul></dd>
 165
 166
 167
 168
 169
 170
 171
 172 </dl>
 173
 174
 175
 176
 177
 178
 179
 180
 181
 182
 183
 184
 185
 186
 187
 188
 189
 190     </div>
 191
 192
 193
 194
 195
 196
 197         <h3 class="subsection-title">Classes</h3>
 198
 199         <dl>
 200             <dt><a href="ProtoBuf.Builder.Message.html">Message</a></dt>
 201             <dd></dd>
 202
 203             <dt><a href="ProtoBuf.Builder.Service.html">Service</a></dt>
 204             <dd></dd>
 205         </dl>
 206
 207
 208
 209
 210
 211
 212
 213         <h3 class="subsection-title">Members</h3>
 214
 215
 216
 217 <h4 class="name" id="files"><span class="type-signature"></span>files<span class="type-signature"> :Array.&lt;string></span></h4>
 218
 219
 220
 221
 222 <div class="description">
 223     <p>Imported files.</p>
 224 </div>
 225
 226
 227
 228     <h5>Type:</h5>
 229     <ul>
 230         <li>
 231
 232 <span class="param-type">Array.&lt;string></span>
 233
 234
 235         </li>
 236     </ul>
 237
 238
 239
 240
 241
 242 <dl class="details">
 243
 244
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260
 261
 262
 263
 264
 265
 266
 267
 268
 269     <dt class="tag-source">Source:</dt>
 270     <dd class="tag-source"><ul class="dummy"><li>
 271         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4330">line 4330</a>
 272     </li></ul></dd>
 273
 274
 275
 276
 277
 278
 279
 280 </dl>
 281
 282
 283
 284
 285
 286
 287
 288
 289 <h4 class="name" id="importRoot"><span class="type-signature">(nullable) </span>importRoot<span class="type-signature"> :string</span></h4>
 290
 291
 292
 293
 294 <div class="description">
 295     <p>Import root override.</p>
 296 </div>
 297
 298
 299
 300     <h5>Type:</h5>
 301     <ul>
 302         <li>
 303
 304 <span class="param-type">string</span>
 305
 306
 307         </li>
 308     </ul>
 309
 310
 311
 312
 313
 314 <dl class="details">
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329
 330
 331
 332
 333
 334
 335
 336
 337
 338
 339
 340
 341     <dt class="tag-source">Source:</dt>
 342     <dd class="tag-source"><ul class="dummy"><li>
 343         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4337">line 4337</a>
 344     </li></ul></dd>
 345
 346
 347
 348
 349
 350
 351
 352 </dl>
 353
 354
 355
 356
 357
 358
 359
 360
 361 <h4 class="name" id="ns"><span class="type-signature"></span>ns<span class="type-signature"> :<a href="ProtoBuf.Reflect.Namespace.html">ProtoBuf.Reflect.Namespace</a></span></h4>
 362
 363
 364
 365
 366 <div class="description">
 367     <p>Namespace.</p>
 368 </div>
 369
 370
 371
 372     <h5>Type:</h5>
 373     <ul>
 374         <li>
 375
 376 <span class="param-type"><a href="ProtoBuf.Reflect.Namespace.html">ProtoBuf.Reflect.Namespace</a></span>
 377
 378
 379         </li>
 380     </ul>
 381
 382
 383
 384
 385
 386 <dl class="details">
 387
 388
 389
 390
 391
 392
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410
 411
 412
 413     <dt class="tag-source">Source:</dt>
 414     <dd class="tag-source"><ul class="dummy"><li>
 415         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4302">line 4302</a>
 416     </li></ul></dd>
 417
 418
 419
 420
 421
 422
 423
 424 </dl>
 425
 426
 427
 428
 429
 430
 431
 432
 433 <h4 class="name" id="options"><span class="type-signature">(non-null) </span>options<span class="type-signature"> :Object.&lt;string, *></span></h4>
 434
 435
 436
 437
 438 <div class="description">
 439     <p>Options.</p>
 440 </div>
 441
 442
 443
 444     <h5>Type:</h5>
 445     <ul>
 446         <li>
 447
 448 <span class="param-type">Object.&lt;string, *></span>
 449
 450
 451         </li>
 452     </ul>
 453
 454
 455
 456
 457
 458 <dl class="details">
 459
 460
 461
 462
 463
 464
 465
 466
 467
 468
 469
 470
 471
 472
 473
 474
 475
 476
 477
 478
 479
 480
 481
 482
 483
 484
 485     <dt class="tag-source">Source:</dt>
 486     <dd class="tag-source"><ul class="dummy"><li>
 487         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4344">line 4344</a>
 488     </li></ul></dd>
 489
 490
 491
 492
 493
 494
 495
 496 </dl>
 497
 498
 499
 500
 501
 502
 503
 504
 505 <h4 class="name" id="ptr"><span class="type-signature"></span>ptr<span class="type-signature"> :<a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span></h4>
 506
 507
 508
 509
 510 <div class="description">
 511     <p>Namespace pointer.</p>
 512 </div>
 513
 514
 515
 516     <h5>Type:</h5>
 517     <ul>
 518         <li>
 519
 520 <span class="param-type"><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span>
 521
 522
 523         </li>
 524     </ul>
 525
 526
 527
 528
 529
 530 <dl class="details">
 531
 532
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544
 545
 546
 547
 548
 549
 550
 551
 552
 553
 554
 555
 556
 557     <dt class="tag-source">Source:</dt>
 558     <dd class="tag-source"><ul class="dummy"><li>
 559         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4309">line 4309</a>
 560     </li></ul></dd>
 561
 562
 563
 564
 565
 566
 567
 568 </dl>
 569
 570
 571
 572
 573
 574
 575
 576
 577 <h4 class="name" id="resolved"><span class="type-signature"></span>resolved<span class="type-signature"> :boolean</span></h4>
 578
 579
 580
 581
 582 <div class="description">
 583     <p>Resolved flag.</p>
 584 </div>
 585
 586
 587
 588     <h5>Type:</h5>
 589     <ul>
 590         <li>
 591
 592 <span class="param-type">boolean</span>
 593
 594
 595         </li>
 596     </ul>
 597
 598
 599
 600
 601
 602 <dl class="details">
 603
 604
 605
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615
 616
 617
 618
 619
 620
 621
 622
 623
 624
 625
 626
 627
 628
 629     <dt class="tag-source">Source:</dt>
 630     <dd class="tag-source"><ul class="dummy"><li>
 631         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4316">line 4316</a>
 632     </li></ul></dd>
 633
 634
 635
 636
 637
 638
 639
 640 </dl>
 641
 642
 643
 644
 645
 646
 647
 648
 649 <h4 class="name" id="result"><span class="type-signature"></span>result<span class="type-signature"> :Object.&lt;string, (<a href="ProtoBuf.Builder.Message.html">ProtoBuf.Builder.Message</a>|Object)>|null</span></h4>
 650
 651
 652
 653
 654 <div class="description">
 655     <p>The current building result.</p>
 656 </div>
 657
 658
 659
 660     <h5>Type:</h5>
 661     <ul>
 662         <li>
 663
 664 <span class="param-type">Object.&lt;string, (<a href="ProtoBuf.Builder.Message.html">ProtoBuf.Builder.Message</a>|Object)></span>
 665 |
 666
 667 <span class="param-type">null</span>
 668
 669
 670         </li>
 671     </ul>
 672
 673
 674
 675
 676
 677 <dl class="details">
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687
 688
 689
 690
 691
 692
 693
 694
 695
 696
 697
 698
 699
 700
 701
 702
 703
 704     <dt class="tag-source">Source:</dt>
 705     <dd class="tag-source"><ul class="dummy"><li>
 706         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4323">line 4323</a>
 707     </li></ul></dd>
 708
 709
 710
 711
 712
 713
 714
 715 </dl>
 716
 717
 718
 719
 720
 721
 722
 723
 724
 725
 726         <h3 class="subsection-title">Methods</h3>
 727
 728
 729
 730
 731
 732
 733     <h4 class="name" id=".isEnum"><span class="type-signature">(static) </span>isEnum<span class="signature">(def<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
 734
 735
 736
 737
 738
 739 <div class="description">
 740     <p>Tests if a definition most likely describes an enum.</p>
 741 </div>
 742
 743
 744
 745
 746
 747
 748
 749
 750
 751     <h5>Parameters:</h5>
 752
 753
 754 <table class="params">
 755     <thead>
 756     <tr>
 757
 758         <th>Name</th>
 759
 760
 761         <th>Type</th>
 762
 763
 764
 765
 766
 767         <th class="last">Description</th>
 768     </tr>
 769     </thead>
 770
 771     <tbody>
 772
 773
 774         <tr>
 775
 776                 <td class="name"><code>def</code></td>
 777
 778
 779             <td class="type">
 780
 781
 782 <span class="param-type">Object</span>
 783
 784
 785
 786             </td>
 787
 788
 789
 790
 791
 792             <td class="description last"></td>
 793         </tr>
 794
 795
 796     </tbody>
 797 </table>
 798
 799
 800
 801
 802
 803
 804 <dl class="details">
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831     <dt class="tag-source">Source:</dt>
 832     <dd class="tag-source"><ul class="dummy"><li>
 833         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4390">line 4390</a>
 834     </li></ul></dd>
 835
 836
 837
 838
 839
 840
 841
 842 </dl>
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856 <h5>Returns:</h5>
 857
 858
 859
 860
 861 <dl>
 862     <dt>
 863         Type
 864     </dt>
 865     <dd>
 866
 867 <span class="param-type">boolean</span>
 868
 869
 870     </dd>
 871 </dl>
 872
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882     <h4 class="name" id=".isExtend"><span class="type-signature">(static) </span>isExtend<span class="signature">(def<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
 883
 884
 885
 886
 887
 888 <div class="description">
 889     <p>Tests if a definition most likely describes an extended message</p>
 890 </div>
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900     <h5>Parameters:</h5>
 901
 902
 903 <table class="params">
 904     <thead>
 905     <tr>
 906
 907         <th>Name</th>
 908
 909
 910         <th>Type</th>
 911
 912
 913
 914
 915
 916         <th class="last">Description</th>
 917     </tr>
 918     </thead>
 919
 920     <tbody>
 921
 922
 923         <tr>
 924
 925                 <td class="name"><code>def</code></td>
 926
 927
 928             <td class="type">
 929
 930
 931 <span class="param-type">Object</span>
 932
 933
 934
 935             </td>
 936
 937
 938
 939
 940
 941             <td class="description last"></td>
 942         </tr>
 943
 944
 945     </tbody>
 946 </table>
 947
 948
 949
 950
 951
 952
 953 <dl class="details">
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980     <dt class="tag-source">Source:</dt>
 981     <dd class="tag-source"><ul class="dummy"><li>
 982         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4419">line 4419</a>
 983     </li></ul></dd>
 984
 985
 986
 987
 988
 989
 990
 991 </dl>
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005 <h5>Returns:</h5>
1006
1007
1008
1009
1010 <dl>
1011     <dt>
1012         Type
1013     </dt>
1014     <dd>
1015
1016 <span class="param-type">boolean</span>
1017
1018
1019     </dd>
1020 </dl>
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031     <h4 class="name" id=".isMessage"><span class="type-signature">(static) </span>isMessage<span class="signature">(def<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
1032
1033
1034
1035
1036
1037 <div class="description">
1038     <p>Tests if a definition most likely describes a message.</p>
1039 </div>
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049     <h5>Parameters:</h5>
1050
1051
1052 <table class="params">
1053     <thead>
1054     <tr>
1055
1056         <th>Name</th>
1057
1058
1059         <th>Type</th>
1060
1061
1062
1063
1064
1065         <th class="last">Description</th>
1066     </tr>
1067     </thead>
1068
1069     <tbody>
1070
1071
1072         <tr>
1073
1074                 <td class="name"><code>def</code></td>
1075
1076
1077             <td class="type">
1078
1079
1080 <span class="param-type">Object</span>
1081
1082
1083
1084             </td>
1085
1086
1087
1088
1089
1090             <td class="description last"></td>
1091         </tr>
1092
1093
1094     </tbody>
1095 </table>
1096
1097
1098
1099
1100
1101
1102 <dl class="details">
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129     <dt class="tag-source">Source:</dt>
1130     <dd class="tag-source"><ul class="dummy"><li>
1131         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4361">line 4361</a>
1132     </li></ul></dd>
1133
1134
1135
1136
1137
1138
1139
1140 </dl>
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154 <h5>Returns:</h5>
1155
1156
1157
1158
1159 <dl>
1160     <dt>
1161         Type
1162     </dt>
1163     <dd>
1164
1165 <span class="param-type">boolean</span>
1166
1167
1168     </dd>
1169 </dl>
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180     <h4 class="name" id=".isMessageField"><span class="type-signature">(static) </span>isMessageField<span class="signature">(def<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
1181
1182
1183
1184
1185
1186 <div class="description">
1187     <p>Tests if a definition most likely describes a message field.</p>
1188 </div>
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198     <h5>Parameters:</h5>
1199
1200
1201 <table class="params">
1202     <thead>
1203     <tr>
1204
1205         <th>Name</th>
1206
1207
1208         <th>Type</th>
1209
1210
1211
1212
1213
1214         <th class="last">Description</th>
1215     </tr>
1216     </thead>
1217
1218     <tbody>
1219
1220
1221         <tr>
1222
1223                 <td class="name"><code>def</code></td>
1224
1225
1226             <td class="type">
1227
1228
1229 <span class="param-type">Object</span>
1230
1231
1232
1233             </td>
1234
1235
1236
1237
1238
1239             <td class="description last"></td>
1240         </tr>
1241
1242
1243     </tbody>
1244 </table>
1245
1246
1247
1248
1249
1250
1251 <dl class="details">
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278     <dt class="tag-source">Source:</dt>
1279     <dd class="tag-source"><ul class="dummy"><li>
1280         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4377">line 4377</a>
1281     </li></ul></dd>
1282
1283
1284
1285
1286
1287
1288
1289 </dl>
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303 <h5>Returns:</h5>
1304
1305
1306
1307
1308 <dl>
1309     <dt>
1310         Type
1311     </dt>
1312     <dd>
1313
1314 <span class="param-type">boolean</span>
1315
1316
1317     </dd>
1318 </dl>
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329     <h4 class="name" id=".isService"><span class="type-signature">(static) </span>isService<span class="signature">(def<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
1330
1331
1332
1333
1334
1335 <div class="description">
1336     <p>Tests if a definition most likely describes a service.</p>
1337 </div>
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347     <h5>Parameters:</h5>
1348
1349
1350 <table class="params">
1351     <thead>
1352     <tr>
1353
1354         <th>Name</th>
1355
1356
1357         <th>Type</th>
1358
1359
1360
1361
1362
1363         <th class="last">Description</th>
1364     </tr>
1365     </thead>
1366
1367     <tbody>
1368
1369
1370         <tr>
1371
1372                 <td class="name"><code>def</code></td>
1373
1374
1375             <td class="type">
1376
1377
1378 <span class="param-type">Object</span>
1379
1380
1381
1382             </td>
1383
1384
1385
1386
1387
1388             <td class="description last"></td>
1389         </tr>
1390
1391
1392     </tbody>
1393 </table>
1394
1395
1396
1397
1398
1399
1400 <dl class="details">
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427     <dt class="tag-source">Source:</dt>
1428     <dd class="tag-source"><ul class="dummy"><li>
1429         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4406">line 4406</a>
1430     </li></ul></dd>
1431
1432
1433
1434
1435
1436
1437
1438 </dl>
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452 <h5>Returns:</h5>
1453
1454
1455
1456
1457 <dl>
1458     <dt>
1459         Type
1460     </dt>
1461     <dd>
1462
1463 <span class="param-type">boolean</span>
1464
1465
1466     </dd>
1467 </dl>
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478     <h4 class="name" id="%22import%22%5D"><span class="type-signature"></span>"import"]<span class="signature">(json, filename<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; (non-null) {<a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a>}</span></h4>
1479
1480
1481
1482
1483
1484 <div class="description">
1485     <p>Imports another definition into this builder.</p>
1486 </div>
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496     <h5>Parameters:</h5>
1497
1498
1499 <table class="params">
1500     <thead>
1501     <tr>
1502
1503         <th>Name</th>
1504
1505
1506         <th>Type</th>
1507
1508
1509         <th>Attributes</th>
1510
1511
1512
1513
1514         <th class="last">Description</th>
1515     </tr>
1516     </thead>
1517
1518     <tbody>
1519
1520
1521         <tr>
1522
1523                 <td class="name"><code>json</code></td>
1524
1525
1526             <td class="type">
1527
1528
1529 <span class="param-type">Object.&lt;string, *></span>
1530
1531
1532
1533             </td>
1534
1535
1536                 <td class="attributes">
1537
1538
1539
1540
1541
1542                 </td>
1543
1544
1545
1546
1547             <td class="description last"><p>Parsed import</p></td>
1548         </tr>
1549
1550
1551
1552         <tr>
1553
1554                 <td class="name"><code>filename</code></td>
1555
1556
1557             <td class="type">
1558
1559
1560 <span class="param-type">string</span>
1561 |
1562
1563 <span class="param-type">Object</span>
1564
1565
1566
1567             </td>
1568
1569
1570                 <td class="attributes">
1571
1572                     &lt;optional><br>
1573
1574
1575
1576
1577
1578                 </td>
1579
1580
1581
1582
1583             <td class="description last"><p>Imported file name</p></td>
1584         </tr>
1585
1586
1587     </tbody>
1588 </table>
1589
1590
1591
1592
1593
1594
1595 <dl class="details">
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622     <dt class="tag-source">Source:</dt>
1623     <dd class="tag-source"><ul class="dummy"><li>
1624         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4640">line 4640</a>
1625     </li></ul></dd>
1626
1627
1628
1629
1630
1631
1632
1633 </dl>
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645 <h5>Throws:</h5>
1646
1647
1648
1649 <dl>
1650     <dt>
1651         <div class="param-desc">
1652         <p>If the definition or file cannot be imported</p>
1653         </div>
1654     </dt>
1655     <dd></dd>
1656     <dt>
1657         <dl>
1658             <dt>
1659                 Type
1660             </dt>
1661             <dd>
1662
1663 <span class="param-type">Error</span>
1664
1665
1666             </dd>
1667         </dl>
1668     </dt>
1669     <dd></dd>
1670 </dl>
1671
1672
1673
1674
1675
1676 <h5>Returns:</h5>
1677
1678
1679 <div class="param-desc">
1680     <p>this</p>
1681 </div>
1682
1683
1684
1685 <dl>
1686     <dt>
1687         Type
1688     </dt>
1689     <dd>
1690
1691 <span class="param-type"><a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a></span>
1692
1693
1694     </dd>
1695 </dl>
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706     <h4 class="name" id="build"><span class="type-signature"></span>build<span class="signature">(path<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="ProtoBuf.Builder.Message.html">ProtoBuf.Builder.Message</a>|!Object.&lt;string, *>}</span></h4>
1707
1708
1709
1710
1711
1712 <div class="description">
1713     <p>Builds the protocol. This will first try to resolve all definitions and, if this has been successful,
1714 return the built package.</p>
1715 </div>
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725     <h5>Parameters:</h5>
1726
1727
1728 <table class="params">
1729     <thead>
1730     <tr>
1731
1732         <th>Name</th>
1733
1734
1735         <th>Type</th>
1736
1737
1738         <th>Attributes</th>
1739
1740
1741
1742
1743         <th class="last">Description</th>
1744     </tr>
1745     </thead>
1746
1747     <tbody>
1748
1749
1750         <tr>
1751
1752                 <td class="name"><code>path</code></td>
1753
1754
1755             <td class="type">
1756
1757
1758 <span class="param-type">string</span>
1759 |
1760
1761 <span class="param-type">Array.&lt;string></span>
1762
1763
1764
1765             </td>
1766
1767
1768                 <td class="attributes">
1769
1770                     &lt;optional><br>
1771
1772
1773
1774
1775
1776                 </td>
1777
1778
1779
1780
1781             <td class="description last"><p>Specifies what to return. If omitted, the entire namespace will be returned.</p></td>
1782         </tr>
1783
1784
1785     </tbody>
1786 </table>
1787
1788
1789
1790
1791
1792
1793 <dl class="details">
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820     <dt class="tag-source">Source:</dt>
1821     <dd class="tag-source"><ul class="dummy"><li>
1822         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4853">line 4853</a>
1823     </li></ul></dd>
1824
1825
1826
1827
1828
1829
1830
1831 </dl>
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843 <h5>Throws:</h5>
1844
1845
1846
1847 <dl>
1848     <dt>
1849         <div class="param-desc">
1850         <p>If a type could not be resolved</p>
1851         </div>
1852     </dt>
1853     <dd></dd>
1854     <dt>
1855         <dl>
1856             <dt>
1857                 Type
1858             </dt>
1859             <dd>
1860
1861 <span class="param-type">Error</span>
1862
1863
1864             </dd>
1865         </dl>
1866     </dt>
1867     <dd></dd>
1868 </dl>
1869
1870
1871
1872
1873
1874 <h5>Returns:</h5>
1875
1876
1877
1878
1879 <dl>
1880     <dt>
1881         Type
1882     </dt>
1883     <dd>
1884
1885 <span class="param-type"><a href="ProtoBuf.Builder.Message.html">ProtoBuf.Builder.Message</a></span>
1886 |
1887
1888 <span class="param-type">!Object.&lt;string, *></span>
1889
1890
1891     </dd>
1892 </dl>
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903     <h4 class="name" id="create"><span class="type-signature"></span>create<span class="signature">(defs<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> &rarr; (non-null) {<a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a>}</span></h4>
1904
1905
1906
1907
1908
1909 <div class="description">
1910     <p>Creates the specified definitions at the current pointer position.</p>
1911 </div>
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921     <h5>Parameters:</h5>
1922
1923
1924 <table class="params">
1925     <thead>
1926     <tr>
1927
1928         <th>Name</th>
1929
1930
1931         <th>Type</th>
1932
1933
1934
1935
1936
1937         <th class="last">Description</th>
1938     </tr>
1939     </thead>
1940
1941     <tbody>
1942
1943
1944         <tr>
1945
1946                 <td class="name"><code>defs</code></td>
1947
1948
1949             <td class="type">
1950
1951
1952 <span class="param-type">Array.&lt;!Object></span>
1953
1954
1955
1956             </td>
1957
1958
1959
1960
1961
1962             <td class="description last"><p>Messages, enums or services to create</p></td>
1963         </tr>
1964
1965
1966     </tbody>
1967 </table>
1968
1969
1970
1971
1972
1973
1974 <dl class="details">
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001     <dt class="tag-source">Source:</dt>
2002     <dd class="tag-source"><ul class="dummy"><li>
2003         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4463">line 4463</a>
2004     </li></ul></dd>
2005
2006
2007
2008
2009
2010
2011
2012 </dl>
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024 <h5>Throws:</h5>
2025
2026
2027
2028 <dl>
2029     <dt>
2030         <div class="param-desc">
2031         <p>If a message definition is invalid</p>
2032         </div>
2033     </dt>
2034     <dd></dd>
2035     <dt>
2036         <dl>
2037             <dt>
2038                 Type
2039             </dt>
2040             <dd>
2041
2042 <span class="param-type">Error</span>
2043
2044
2045             </dd>
2046         </dl>
2047     </dt>
2048     <dd></dd>
2049 </dl>
2050
2051
2052
2053
2054
2055 <h5>Returns:</h5>
2056
2057
2058 <div class="param-desc">
2059     <p>this</p>
2060 </div>
2061
2062
2063
2064 <dl>
2065     <dt>
2066         Type
2067     </dt>
2068     <dd>
2069
2070 <span class="param-type"><a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a></span>
2071
2072
2073     </dd>
2074 </dl>
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085     <h4 class="name" id="define"><span class="type-signature"></span>define<span class="signature">(namespace)</span><span class="type-signature"> &rarr; (non-null) {<a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a>}</span></h4>
2086
2087
2088
2089
2090
2091 <div class="description">
2092     <p>Defines a namespace on top of the current pointer position and places the pointer on it.</p>
2093 </div>
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103     <h5>Parameters:</h5>
2104
2105
2106 <table class="params">
2107     <thead>
2108     <tr>
2109
2110         <th>Name</th>
2111
2112
2113         <th>Type</th>
2114
2115
2116
2117
2118
2119         <th class="last">Description</th>
2120     </tr>
2121     </thead>
2122
2123     <tbody>
2124
2125
2126         <tr>
2127
2128                 <td class="name"><code>namespace</code></td>
2129
2130
2131             <td class="type">
2132
2133
2134 <span class="param-type">string</span>
2135
2136
2137
2138             </td>
2139
2140
2141
2142
2143
2144             <td class="description last"></td>
2145         </tr>
2146
2147
2148     </tbody>
2149 </table>
2150
2151
2152
2153
2154
2155
2156 <dl class="details">
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183     <dt class="tag-source">Source:</dt>
2184     <dd class="tag-source"><ul class="dummy"><li>
2185         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4444">line 4444</a>
2186     </li></ul></dd>
2187
2188
2189
2190
2191
2192
2193
2194 </dl>
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208 <h5>Returns:</h5>
2209
2210
2211 <div class="param-desc">
2212     <p>this</p>
2213 </div>
2214
2215
2216
2217 <dl>
2218     <dt>
2219         Type
2220     </dt>
2221     <dd>
2222
2223 <span class="param-type"><a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a></span>
2224
2225
2226     </dd>
2227 </dl>
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238     <h4 class="name" id="lookup"><span class="type-signature"></span>lookup<span class="signature">(path<span class="signature-attributes">opt</span>, excludeNonNamespace<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; (nullable) {<a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a>}</span></h4>
2239
2240
2241
2242
2243
2244 <div class="description">
2245     <p>Similar to <a href="ProtoBuf.Builder.html#build">ProtoBuf.Builder#build</a>, but looks up the internal reflection descriptor.</p>
2246 </div>
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256     <h5>Parameters:</h5>
2257
2258
2259 <table class="params">
2260     <thead>
2261     <tr>
2262
2263         <th>Name</th>
2264
2265
2266         <th>Type</th>
2267
2268
2269         <th>Attributes</th>
2270
2271
2272
2273
2274         <th class="last">Description</th>
2275     </tr>
2276     </thead>
2277
2278     <tbody>
2279
2280
2281         <tr>
2282
2283                 <td class="name"><code>path</code></td>
2284
2285
2286             <td class="type">
2287
2288
2289 <span class="param-type">string</span>
2290
2291
2292
2293             </td>
2294
2295
2296                 <td class="attributes">
2297
2298                     &lt;optional><br>
2299
2300
2301
2302
2303
2304                 </td>
2305
2306
2307
2308
2309             <td class="description last"><p>Specifies what to return. If omitted, the entire namespace wiil be returned.</p></td>
2310         </tr>
2311
2312
2313
2314         <tr>
2315
2316                 <td class="name"><code>excludeNonNamespace</code></td>
2317
2318
2319             <td class="type">
2320
2321
2322 <span class="param-type">boolean</span>
2323
2324
2325
2326             </td>
2327
2328
2329                 <td class="attributes">
2330
2331                     &lt;optional><br>
2332
2333
2334
2335
2336
2337                 </td>
2338
2339
2340
2341
2342             <td class="description last"><p>Excludes non-namespace types like fields, defaults to <code>false</code></p></td>
2343         </tr>
2344
2345
2346     </tbody>
2347 </table>
2348
2349
2350
2351
2352
2353
2354 <dl class="details">
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381     <dt class="tag-source">Source:</dt>
2382     <dd class="tag-source"><ul class="dummy"><li>
2383         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4881">line 4881</a>
2384     </li></ul></dd>
2385
2386
2387
2388
2389
2390
2391
2392 </dl>
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406 <h5>Returns:</h5>
2407
2408
2409 <div class="param-desc">
2410     <p>Reflection descriptor or <code>null</code> if not found</p>
2411 </div>
2412
2413
2414
2415 <dl>
2416     <dt>
2417         Type
2418     </dt>
2419     <dd>
2420
2421 <span class="param-type"><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span>
2422
2423
2424     </dd>
2425 </dl>
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436     <h4 class="name" id="reset"><span class="type-signature"></span>reset<span class="signature">()</span><span class="type-signature"> &rarr; (non-null) {<a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a>}</span></h4>
2437
2438
2439
2440
2441
2442 <div class="description">
2443     <p>Resets the pointer to the root namespace.</p>
2444 </div>
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458 <dl class="details">
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485     <dt class="tag-source">Source:</dt>
2486     <dd class="tag-source"><ul class="dummy"><li>
2487         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4433">line 4433</a>
2488     </li></ul></dd>
2489
2490
2491
2492
2493
2494
2495
2496 </dl>
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510 <h5>Returns:</h5>
2511
2512
2513 <div class="param-desc">
2514     <p>this</p>
2515 </div>
2516
2517
2518
2519 <dl>
2520     <dt>
2521         Type
2522     </dt>
2523     <dd>
2524
2525 <span class="param-type"><a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a></span>
2526
2527
2528     </dd>
2529 </dl>
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540     <h4 class="name" id="resolveAll"><span class="type-signature"></span>resolveAll<span class="signature">()</span><span class="type-signature"> &rarr; (non-null) {<a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a>}</span></h4>
2541
2542
2543
2544
2545
2546 <div class="description">
2547     <p>Resolves all namespace objects.</p>
2548 </div>
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562 <dl class="details">
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589     <dt class="tag-source">Source:</dt>
2590     <dd class="tag-source"><ul class="dummy"><li>
2591         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4769">line 4769</a>
2592     </li></ul></dd>
2593
2594
2595
2596
2597
2598
2599
2600 </dl>
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612 <h5>Throws:</h5>
2613
2614
2615
2616 <dl>
2617     <dt>
2618         <div class="param-desc">
2619         <p>If a type cannot be resolved</p>
2620         </div>
2621     </dt>
2622     <dd></dd>
2623     <dt>
2624         <dl>
2625             <dt>
2626                 Type
2627             </dt>
2628             <dd>
2629
2630 <span class="param-type">Error</span>
2631
2632
2633             </dd>
2634         </dl>
2635     </dt>
2636     <dd></dd>
2637 </dl>
2638
2639
2640
2641
2642
2643 <h5>Returns:</h5>
2644
2645
2646 <div class="param-desc">
2647     <p>this</p>
2648 </div>
2649
2650
2651
2652 <dl>
2653     <dt>
2654         Type
2655     </dt>
2656     <dd>
2657
2658 <span class="param-type"><a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a></span>
2659
2660
2661     </dd>
2662 </dl>
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673     <h4 class="name" id="toString"><span class="type-signature"></span>toString<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
2674
2675
2676
2677
2678
2679 <div class="description">
2680     <p>Returns a string representation of this object.</p>
2681 </div>
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695 <dl class="details">
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722     <dt class="tag-source">Source:</dt>
2723     <dd class="tag-source"><ul class="dummy"><li>
2724         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4890">line 4890</a>
2725     </li></ul></dd>
2726
2727
2728
2729
2730
2731
2732
2733 </dl>
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747 <h5>Returns:</h5>
2748
2749
2750 <div class="param-desc">
2751     <p>String representation as of &quot;Builder&quot;</p>
2752 </div>
2753
2754
2755
2756 <dl>
2757     <dt>
2758         Type
2759     </dt>
2760     <dd>
2761
2762 <span class="param-type">string</span>
2763
2764
2765     </dd>
2766 </dl>
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778 </article>
2779
2780 </section>
2781
2782
2783
2784
2785 </div>
2786
2787 <nav>
2788     <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>
2789 </nav>
2790
2791 <br class="clear">
2792
2793 <footer>
2794     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)
2795 </footer>
2796
2797 <script> prettyPrint(); </script>
2798 <script src="scripts/linenumber.js"> </script>
2799 </body>
2800 </html>