legacy-libs/grpc-cloned/node_modules/protobufjs/docs/ProtoBuf.Reflect.Namespace.html

   1 <!DOCTYPE html>
   2 <html lang="en">
   3 <head>
   4     <meta charset="utf-8">
   5     <title>JSDoc: Class: Namespace</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: Namespace</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.Reflect.html">.Reflect</a>.</span>
  33
  34         Namespace
  35         </h2>
  36
  37
  38 </header>
  39
  40 <article>
  41     <div class="container-overview">
  42
  43
  44
  45
  46
  47     <h4 class="name" id="Namespace"><span class="type-signature"></span>new Namespace<span class="signature">(builder<span class="signature-attributes">non-null</span>, parent<span class="signature-attributes">nullable</span>, name, options<span class="signature-attributes">opt</span>, syntax<span class="signature-attributes">nullable</span>)</span><span class="type-signature"></span></h4>
  48
  49
  50
  51
  52
  53 <div class="description">
  54     <p>Constructs a new Namespace.</p>
  55 </div>
  56
  57
  58
  59
  60
  61
  62
  63
  64
  65     <h5>Parameters:</h5>
  66
  67
  68 <table class="params">
  69     <thead>
  70     <tr>
  71
  72         <th>Name</th>
  73
  74
  75         <th>Type</th>
  76
  77
  78         <th>Attributes</th>
  79
  80
  81
  82
  83         <th class="last">Description</th>
  84     </tr>
  85     </thead>
  86
  87     <tbody>
  88
  89
  90         <tr>
  91
  92                 <td class="name"><code>builder</code></td>
  93
  94
  95             <td class="type">
  96
  97
  98 <span class="param-type"><a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a></span>
  99
 100
 101
 102             </td>
 103
 104
 105                 <td class="attributes">
 106
 107
 108
 109
 110
 111                 </td>
 112
 113
 114
 115
 116             <td class="description last"><p>Builder reference</p></td>
 117         </tr>
 118
 119
 120
 121         <tr>
 122
 123                 <td class="name"><code>parent</code></td>
 124
 125
 126             <td class="type">
 127
 128
 129 <span class="param-type"><a href="ProtoBuf.Reflect.Namespace.html">ProtoBuf.Reflect.Namespace</a></span>
 130
 131
 132
 133             </td>
 134
 135
 136                 <td class="attributes">
 137
 138
 139
 140                     &lt;nullable><br>
 141
 142
 143
 144                 </td>
 145
 146
 147
 148
 149             <td class="description last"><p>Namespace parent</p></td>
 150         </tr>
 151
 152
 153
 154         <tr>
 155
 156                 <td class="name"><code>name</code></td>
 157
 158
 159             <td class="type">
 160
 161
 162 <span class="param-type">string</span>
 163
 164
 165
 166             </td>
 167
 168
 169                 <td class="attributes">
 170
 171
 172
 173
 174
 175                 </td>
 176
 177
 178
 179
 180             <td class="description last"><p>Namespace name</p></td>
 181         </tr>
 182
 183
 184
 185         <tr>
 186
 187                 <td class="name"><code>options</code></td>
 188
 189
 190             <td class="type">
 191
 192
 193 <span class="param-type">Object.&lt;string, *></span>
 194
 195
 196
 197             </td>
 198
 199
 200                 <td class="attributes">
 201
 202                     &lt;optional><br>
 203
 204
 205
 206
 207
 208                 </td>
 209
 210
 211
 212
 213             <td class="description last"><p>Namespace options</p></td>
 214         </tr>
 215
 216
 217
 218         <tr>
 219
 220                 <td class="name"><code>syntax</code></td>
 221
 222
 223             <td class="type">
 224
 225
 226 <span class="param-type">string</span>
 227
 228
 229
 230             </td>
 231
 232
 233                 <td class="attributes">
 234
 235
 236
 237                     &lt;nullable><br>
 238
 239
 240
 241                 </td>
 242
 243
 244
 245
 246             <td class="description last"><p>The syntax level of this definition (e.g., proto3)</p></td>
 247         </tr>
 248
 249
 250     </tbody>
 251 </table>
 252
 253
 254
 255
 256
 257
 258 <dl class="details">
 259
 260
 261
 262
 263
 264
 265
 266
 267
 268
 269
 270
 271
 272
 273
 274
 275
 276
 277
 278
 279
 280
 281
 282
 283
 284
 285     <dt class="tag-source">Source:</dt>
 286     <dd class="tag-source"><ul class="dummy"><li>
 287         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1500">line 1500</a>
 288     </li></ul></dd>
 289
 290
 291
 292
 293
 294
 295
 296 </dl>
 297
 298
 299
 300
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310
 311
 312
 313
 314     </div>
 315
 316
 317         <h3 class="subsection-title">Extends</h3>
 318
 319
 320
 321
 322     <ul>
 323         <li><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></li>
 324     </ul>
 325
 326
 327
 328
 329
 330
 331
 332
 333
 334
 335
 336
 337
 338         <h3 class="subsection-title">Members</h3>
 339
 340
 341
 342 <h4 class="name" id="builder"><span class="type-signature">(non-null) </span>builder<span class="type-signature"> :<a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a></span></h4>
 343
 344
 345
 346
 347 <div class="description">
 348     <p>Builder reference.</p>
 349 </div>
 350
 351
 352
 353     <h5>Type:</h5>
 354     <ul>
 355         <li>
 356
 357 <span class="param-type"><a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a></span>
 358
 359
 360         </li>
 361     </ul>
 362
 363
 364
 365
 366
 367 <dl class="details">
 368
 369
 370
 371
 372
 373
 374     <dt class="inherited-from">Inherited From:</dt>
 375     <dd class="inherited-from"><ul class="dummy"><li>
 376         <a href="ProtoBuf.Reflect.T.html#builder">ProtoBuf.Reflect.T#builder</a>
 377     </li></ul></dd>
 378
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392
 393
 394
 395
 396
 397
 398
 399     <dt class="tag-source">Source:</dt>
 400     <dd class="tag-source"><ul class="dummy"><li>
 401         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1417">line 1417</a>
 402     </li></ul></dd>
 403
 404
 405
 406
 407
 408
 409
 410 </dl>
 411
 412
 413
 414
 415
 416
 417
 418
 419 <h4 class="name" id="children"><span class="type-signature">(non-null) </span>children<span class="type-signature"> :Array.&lt;<a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a>></span></h4>
 420
 421
 422
 423
 424 <div class="description">
 425     <p>Children inside the namespace.</p>
 426 </div>
 427
 428
 429
 430     <h5>Type:</h5>
 431     <ul>
 432         <li>
 433
 434 <span class="param-type">Array.&lt;<a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a>></span>
 435
 436
 437         </li>
 438     </ul>
 439
 440
 441
 442
 443
 444 <dl class="details">
 445
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455
 456
 457
 458
 459
 460
 461
 462
 463
 464
 465
 466
 467
 468
 469
 470
 471     <dt class="tag-source">Source:</dt>
 472     <dd class="tag-source"><ul class="dummy"><li>
 473         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1512">line 1512</a>
 474     </li></ul></dd>
 475
 476
 477
 478
 479
 480
 481
 482 </dl>
 483
 484
 485
 486
 487
 488
 489
 490
 491 <h4 class="name" id="className"><span class="type-signature"></span>className<span class="type-signature"> :string</span></h4>
 492
 493
 494
 495
 496 <div class="description">
 497     <p>Fully qualified class name</p>
 498 </div>
 499
 500
 501
 502     <h5>Type:</h5>
 503     <ul>
 504         <li>
 505
 506 <span class="param-type">string</span>
 507
 508
 509         </li>
 510     </ul>
 511
 512
 513
 514
 515
 516 <dl class="details">
 517
 518
 519
 520
 521
 522
 523
 524
 525     <dt class="tag-overrides">Overrides:</dt>
 526     <dd class="tag-overrides"><ul class="dummy"><li>
 527         <a href="ProtoBuf.Reflect.T.html#className">ProtoBuf.Reflect.T#className</a>
 528     </li></ul></dd>
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544
 545
 546
 547
 548     <dt class="tag-source">Source:</dt>
 549     <dd class="tag-source"><ul class="dummy"><li>
 550         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1438">line 1438</a>
 551     </li></ul></dd>
 552
 553
 554
 555
 556
 557
 558
 559 </dl>
 560
 561
 562
 563
 564
 565
 566
 567
 568 <h4 class="name" id="name"><span class="type-signature"></span>name<span class="type-signature"> :string</span></h4>
 569
 570
 571
 572
 573 <div class="description">
 574     <p>Object name in namespace.</p>
 575 </div>
 576
 577
 578
 579     <h5>Type:</h5>
 580     <ul>
 581         <li>
 582
 583 <span class="param-type">string</span>
 584
 585
 586         </li>
 587     </ul>
 588
 589
 590
 591
 592
 593 <dl class="details">
 594
 595
 596
 597
 598
 599
 600     <dt class="inherited-from">Inherited From:</dt>
 601     <dd class="inherited-from"><ul class="dummy"><li>
 602         <a href="ProtoBuf.Reflect.T.html#name">ProtoBuf.Reflect.T#name</a>
 603     </li></ul></dd>
 604
 605
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615
 616
 617
 618
 619
 620
 621
 622
 623
 624
 625     <dt class="tag-source">Source:</dt>
 626     <dd class="tag-source"><ul class="dummy"><li>
 627         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1431">line 1431</a>
 628     </li></ul></dd>
 629
 630
 631
 632
 633
 634
 635
 636 </dl>
 637
 638
 639
 640
 641
 642
 643
 644
 645 <h4 class="name" id="options"><span class="type-signature">(non-null) </span>options<span class="type-signature"> :Object.&lt;string, *></span></h4>
 646
 647
 648
 649
 650 <div class="description">
 651     <p>Options.</p>
 652 </div>
 653
 654
 655
 656     <h5>Type:</h5>
 657     <ul>
 658         <li>
 659
 660 <span class="param-type">Object.&lt;string, *></span>
 661
 662
 663         </li>
 664     </ul>
 665
 666
 667
 668
 669
 670 <dl class="details">
 671
 672
 673
 674
 675
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687
 688
 689
 690
 691
 692
 693
 694
 695
 696
 697     <dt class="tag-source">Source:</dt>
 698     <dd class="tag-source"><ul class="dummy"><li>
 699         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1518">line 1518</a>
 700     </li></ul></dd>
 701
 702
 703
 704
 705
 706
 707
 708 </dl>
 709
 710
 711
 712
 713
 714
 715
 716
 717 <h4 class="name" id="parent"><span class="type-signature">(nullable) </span>parent<span class="type-signature"> :<a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span></h4>
 718
 719
 720
 721
 722 <div class="description">
 723     <p>Parent object.</p>
 724 </div>
 725
 726
 727
 728     <h5>Type:</h5>
 729     <ul>
 730         <li>
 731
 732 <span class="param-type"><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span>
 733
 734
 735         </li>
 736     </ul>
 737
 738
 739
 740
 741
 742 <dl class="details">
 743
 744
 745
 746
 747
 748
 749     <dt class="inherited-from">Inherited From:</dt>
 750     <dd class="inherited-from"><ul class="dummy"><li>
 751         <a href="ProtoBuf.Reflect.T.html#parent">ProtoBuf.Reflect.T#parent</a>
 752     </li></ul></dd>
 753
 754
 755
 756
 757
 758
 759
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774     <dt class="tag-source">Source:</dt>
 775     <dd class="tag-source"><ul class="dummy"><li>
 776         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1424">line 1424</a>
 777     </li></ul></dd>
 778
 779
 780
 781
 782
 783
 784
 785 </dl>
 786
 787
 788
 789
 790
 791
 792
 793
 794 <h4 class="name" id="syntax"><span class="type-signature">(non-null) </span>syntax<span class="type-signature"> :string</span></h4>
 795
 796
 797
 798
 799 <div class="description">
 800     <p>Syntax level (e.g., proto2 or proto3).</p>
 801 </div>
 802
 803
 804
 805     <h5>Type:</h5>
 806     <ul>
 807         <li>
 808
 809 <span class="param-type">string</span>
 810
 811
 812         </li>
 813     </ul>
 814
 815
 816
 817
 818
 819 <dl class="details">
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846     <dt class="tag-source">Source:</dt>
 847     <dd class="tag-source"><ul class="dummy"><li>
 848         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1524">line 1524</a>
 849     </li></ul></dd>
 850
 851
 852
 853
 854
 855
 856
 857 </dl>
 858
 859
 860
 861
 862
 863
 864
 865
 866
 867
 868         <h3 class="subsection-title">Methods</h3>
 869
 870
 871
 872
 873
 874
 875     <h4 class="name" id="addChild"><span class="type-signature"></span>addChild<span class="signature">(child)</span><span class="type-signature"></span></h4>
 876
 877
 878
 879
 880
 881 <div class="description">
 882     <p>Adds a child to the namespace.</p>
 883 </div>
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893     <h5>Parameters:</h5>
 894
 895
 896 <table class="params">
 897     <thead>
 898     <tr>
 899
 900         <th>Name</th>
 901
 902
 903         <th>Type</th>
 904
 905
 906
 907
 908
 909         <th class="last">Description</th>
 910     </tr>
 911     </thead>
 912
 913     <tbody>
 914
 915
 916         <tr>
 917
 918                 <td class="name"><code>child</code></td>
 919
 920
 921             <td class="type">
 922
 923
 924 <span class="param-type"><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span>
 925
 926
 927
 928             </td>
 929
 930
 931
 932
 933
 934             <td class="description last"><p>Child</p></td>
 935         </tr>
 936
 937
 938     </tbody>
 939 </table>
 940
 941
 942
 943
 944
 945
 946 <dl class="details">
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973     <dt class="tag-source">Source:</dt>
 974     <dd class="tag-source"><ul class="dummy"><li>
 975         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1556">line 1556</a>
 976     </li></ul></dd>
 977
 978
 979
 980
 981
 982
 983
 984 </dl>
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996 <h5>Throws:</h5>
 997
 998
 999
1000 <dl>
1001     <dt>
1002         <div class="param-desc">
1003         <p>If the child cannot be added (duplicate)</p>
1004         </div>
1005     </dt>
1006     <dd></dd>
1007     <dt>
1008         <dl>
1009             <dt>
1010                 Type
1011             </dt>
1012             <dd>
1013
1014 <span class="param-type">Error</span>
1015
1016
1017             </dd>
1018         </dl>
1019     </dt>
1020     <dd></dd>
1021 </dl>
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035     <h4 class="name" id="build"><span class="type-signature"></span>build<span class="signature">()</span><span class="type-signature"> &rarr; {Object.&lt;string, (function()|Object)>}</span></h4>
1036
1037
1038
1039
1040
1041 <div class="description">
1042     <p>Builds the namespace and returns the runtime counterpart.</p>
1043 </div>
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057 <dl class="details">
1058
1059
1060
1061
1062
1063
1064
1065
1066     <dt class="tag-overrides">Overrides:</dt>
1067     <dd class="tag-overrides"><ul class="dummy"><li>
1068         <a href="ProtoBuf.Reflect.T.html#build">ProtoBuf.Reflect.T#build</a>
1069     </li></ul></dd>
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089     <dt class="tag-source">Source:</dt>
1090     <dd class="tag-source"><ul class="dummy"><li>
1091         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1648">line 1648</a>
1092     </li></ul></dd>
1093
1094
1095
1096
1097
1098
1099
1100 </dl>
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114 <h5>Returns:</h5>
1115
1116
1117 <div class="param-desc">
1118     <p>Runtime namespace</p>
1119 </div>
1120
1121
1122
1123 <dl>
1124     <dt>
1125         Type
1126     </dt>
1127     <dd>
1128
1129 <span class="param-type">Object.&lt;string, (function()|Object)></span>
1130
1131
1132     </dd>
1133 </dl>
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144     <h4 class="name" id="buildOpt"><span class="type-signature"></span>buildOpt<span class="signature">()</span><span class="type-signature"> &rarr; {Object.&lt;string, *>}</span></h4>
1145
1146
1147
1148
1149
1150 <div class="description">
1151     <p>Builds the namespace's '$options' property.</p>
1152 </div>
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166 <dl class="details">
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193     <dt class="tag-source">Source:</dt>
1194     <dd class="tag-source"><ul class="dummy"><li>
1195         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1666">line 1666</a>
1196     </li></ul></dd>
1197
1198
1199
1200
1201
1202
1203
1204 </dl>
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218 <h5>Returns:</h5>
1219
1220
1221
1222
1223 <dl>
1224     <dt>
1225         Type
1226     </dt>
1227     <dd>
1228
1229 <span class="param-type">Object.&lt;string, *></span>
1230
1231
1232     </dd>
1233 </dl>
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244     <h4 class="name" id="fqn"><span class="type-signature"></span>fqn<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
1245
1246
1247
1248
1249
1250 <div class="description">
1251     <p>Returns the fully qualified name of this object.</p>
1252 </div>
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266 <dl class="details">
1267
1268
1269
1270
1271
1272
1273     <dt class="inherited-from">Inherited From:</dt>
1274     <dd class="inherited-from"><ul class="dummy"><li>
1275         <a href="ProtoBuf.Reflect.T.html#fqn">ProtoBuf.Reflect.T#fqn</a>
1276     </li></ul></dd>
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298     <dt class="tag-source">Source:</dt>
1299     <dd class="tag-source"><ul class="dummy"><li>
1300         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1452">line 1452</a>
1301     </li></ul></dd>
1302
1303
1304
1305
1306
1307
1308
1309 </dl>
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323 <h5>Returns:</h5>
1324
1325
1326 <div class="param-desc">
1327     <p>Fully qualified name as of &quot;.PATH.TO.THIS&quot;</p>
1328 </div>
1329
1330
1331
1332 <dl>
1333     <dt>
1334         Type
1335     </dt>
1336     <dd>
1337
1338 <span class="param-type">string</span>
1339
1340
1341     </dd>
1342 </dl>
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353     <h4 class="name" id="getChild"><span class="type-signature"></span>getChild<span class="signature">(nameOrId)</span><span class="type-signature"> &rarr; (nullable) {<a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a>}</span></h4>
1354
1355
1356
1357
1358
1359 <div class="description">
1360     <p>Gets a child by its name or id.</p>
1361 </div>
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371     <h5>Parameters:</h5>
1372
1373
1374 <table class="params">
1375     <thead>
1376     <tr>
1377
1378         <th>Name</th>
1379
1380
1381         <th>Type</th>
1382
1383
1384
1385
1386
1387         <th class="last">Description</th>
1388     </tr>
1389     </thead>
1390
1391     <tbody>
1392
1393
1394         <tr>
1395
1396                 <td class="name"><code>nameOrId</code></td>
1397
1398
1399             <td class="type">
1400
1401
1402 <span class="param-type">string</span>
1403 |
1404
1405 <span class="param-type">number</span>
1406
1407
1408
1409             </td>
1410
1411
1412
1413
1414
1415             <td class="description last"><p>Child name or id</p></td>
1416         </tr>
1417
1418
1419     </tbody>
1420 </table>
1421
1422
1423
1424
1425
1426
1427 <dl class="details">
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454     <dt class="tag-source">Source:</dt>
1455     <dd class="tag-source"><ul class="dummy"><li>
1456         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1576">line 1576</a>
1457     </li></ul></dd>
1458
1459
1460
1461
1462
1463
1464
1465 </dl>
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479 <h5>Returns:</h5>
1480
1481
1482 <div class="param-desc">
1483     <p>The child or null if not found</p>
1484 </div>
1485
1486
1487
1488 <dl>
1489     <dt>
1490         Type
1491     </dt>
1492     <dd>
1493
1494 <span class="param-type"><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span>
1495
1496
1497     </dd>
1498 </dl>
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509     <h4 class="name" id="getChildren"><span class="type-signature"></span>getChildren<span class="signature">(type<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a>>}</span></h4>
1510
1511
1512
1513
1514
1515 <div class="description">
1516     <p>Returns an array of the namespace's children.</p>
1517 </div>
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527     <h5>Parameters:</h5>
1528
1529
1530 <table class="params">
1531     <thead>
1532     <tr>
1533
1534         <th>Name</th>
1535
1536
1537         <th>Type</th>
1538
1539
1540         <th>Attributes</th>
1541
1542
1543
1544
1545         <th class="last">Description</th>
1546     </tr>
1547     </thead>
1548
1549     <tbody>
1550
1551
1552         <tr>
1553
1554                 <td class="name"><code>type</code></td>
1555
1556
1557             <td class="type">
1558
1559
1560 <span class="param-type"><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span>
1561
1562
1563
1564             </td>
1565
1566
1567                 <td class="attributes">
1568
1569                     &lt;optional><br>
1570
1571
1572
1573
1574
1575                 </td>
1576
1577
1578
1579
1580             <td class="description last"><p>Filter type (returns instances of this type only). Defaults to null (all children).</p></td>
1581         </tr>
1582
1583
1584     </tbody>
1585 </table>
1586
1587
1588
1589
1590
1591
1592 <dl class="details">
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619     <dt class="tag-source">Source:</dt>
1620     <dd class="tag-source"><ul class="dummy"><li>
1621         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1539">line 1539</a>
1622     </li></ul></dd>
1623
1624
1625
1626
1627
1628
1629
1630 </dl>
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644 <h5>Returns:</h5>
1645
1646
1647
1648
1649 <dl>
1650     <dt>
1651         Type
1652     </dt>
1653     <dd>
1654
1655 <span class="param-type">Array.&lt;<a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a>></span>
1656
1657
1658     </dd>
1659 </dl>
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670     <h4 class="name" id="getOption"><span class="type-signature"></span>getOption<span class="signature">(name<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {*|Object.&lt;string, *>}</span></h4>
1671
1672
1673
1674
1675
1676 <div class="description">
1677     <p>Gets the value assigned to the option with the specified name.</p>
1678 </div>
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688     <h5>Parameters:</h5>
1689
1690
1691 <table class="params">
1692     <thead>
1693     <tr>
1694
1695         <th>Name</th>
1696
1697
1698         <th>Type</th>
1699
1700
1701         <th>Attributes</th>
1702
1703
1704
1705
1706         <th class="last">Description</th>
1707     </tr>
1708     </thead>
1709
1710     <tbody>
1711
1712
1713         <tr>
1714
1715                 <td class="name"><code>name</code></td>
1716
1717
1718             <td class="type">
1719
1720
1721 <span class="param-type">string</span>
1722
1723
1724
1725             </td>
1726
1727
1728                 <td class="attributes">
1729
1730                     &lt;optional><br>
1731
1732
1733
1734
1735
1736                 </td>
1737
1738
1739
1740
1741             <td class="description last"><p>Returns the option value if specified, otherwise all options are returned.</p></td>
1742         </tr>
1743
1744
1745     </tbody>
1746 </table>
1747
1748
1749
1750
1751
1752
1753 <dl class="details">
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780     <dt class="tag-source">Source:</dt>
1781     <dd class="tag-source"><ul class="dummy"><li>
1782         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1687">line 1687</a>
1783     </li></ul></dd>
1784
1785
1786
1787
1788
1789
1790
1791 </dl>
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805 <h5>Returns:</h5>
1806
1807
1808 <div class="param-desc">
1809     <p>null} Option value or NULL if there is no such option</p>
1810 </div>
1811
1812
1813
1814 <dl>
1815     <dt>
1816         Type
1817     </dt>
1818     <dd>
1819
1820 <span class="param-type">*</span>
1821 |
1822
1823 <span class="param-type">Object.&lt;string, *></span>
1824
1825
1826     </dd>
1827 </dl>
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838     <h4 class="name" id="qn"><span class="type-signature"></span>qn<span class="signature">(t<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> &rarr; {string}</span></h4>
1839
1840
1841
1842
1843
1844 <div class="description">
1845     <p>Determines the shortest qualified name of the specified type, if any, relative to this namespace.</p>
1846 </div>
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856     <h5>Parameters:</h5>
1857
1858
1859 <table class="params">
1860     <thead>
1861     <tr>
1862
1863         <th>Name</th>
1864
1865
1866         <th>Type</th>
1867
1868
1869
1870
1871
1872         <th class="last">Description</th>
1873     </tr>
1874     </thead>
1875
1876     <tbody>
1877
1878
1879         <tr>
1880
1881                 <td class="name"><code>t</code></td>
1882
1883
1884             <td class="type">
1885
1886
1887 <span class="param-type"><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span>
1888
1889
1890
1891             </td>
1892
1893
1894
1895
1896
1897             <td class="description last"><p>Reflection type</p></td>
1898         </tr>
1899
1900
1901     </tbody>
1902 </table>
1903
1904
1905
1906
1907
1908
1909 <dl class="details">
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936     <dt class="tag-source">Source:</dt>
1937     <dd class="tag-source"><ul class="dummy"><li>
1938         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1629">line 1629</a>
1939     </li></ul></dd>
1940
1941
1942
1943
1944
1945
1946
1947 </dl>
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961 <h5>Returns:</h5>
1962
1963
1964 <div class="param-desc">
1965     <p>The shortest qualified name or, if there is none, the fqn</p>
1966 </div>
1967
1968
1969
1970 <dl>
1971     <dt>
1972         Type
1973     </dt>
1974     <dd>
1975
1976 <span class="param-type">string</span>
1977
1978
1979     </dd>
1980 </dl>
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991     <h4 class="name" id="resolve"><span class="type-signature"></span>resolve<span class="signature">(qn, excludeNonNamespace<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; (nullable) {<a href="ProtoBuf.Reflect.Namespace.html">ProtoBuf.Reflect.Namespace</a>}</span></h4>
1992
1993
1994
1995
1996
1997 <div class="description">
1998     <p>Resolves a reflect object inside of this namespace.</p>
1999 </div>
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009     <h5>Parameters:</h5>
2010
2011
2012 <table class="params">
2013     <thead>
2014     <tr>
2015
2016         <th>Name</th>
2017
2018
2019         <th>Type</th>
2020
2021
2022         <th>Attributes</th>
2023
2024
2025
2026
2027         <th class="last">Description</th>
2028     </tr>
2029     </thead>
2030
2031     <tbody>
2032
2033
2034         <tr>
2035
2036                 <td class="name"><code>qn</code></td>
2037
2038
2039             <td class="type">
2040
2041
2042 <span class="param-type">string</span>
2043 |
2044
2045 <span class="param-type">!Array.&lt;string></span>
2046
2047
2048
2049             </td>
2050
2051
2052                 <td class="attributes">
2053
2054
2055
2056
2057
2058                 </td>
2059
2060
2061
2062
2063             <td class="description last"><p>Qualified name to resolve</p></td>
2064         </tr>
2065
2066
2067
2068         <tr>
2069
2070                 <td class="name"><code>excludeNonNamespace</code></td>
2071
2072
2073             <td class="type">
2074
2075
2076 <span class="param-type">boolean</span>
2077
2078
2079
2080             </td>
2081
2082
2083                 <td class="attributes">
2084
2085                     &lt;optional><br>
2086
2087
2088
2089
2090
2091                 </td>
2092
2093
2094
2095
2096             <td class="description last"><p>Excludes non-namespace types, defaults to <code>false</code></p></td>
2097         </tr>
2098
2099
2100     </tbody>
2101 </table>
2102
2103
2104
2105
2106
2107
2108 <dl class="details">
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135     <dt class="tag-source">Source:</dt>
2136     <dd class="tag-source"><ul class="dummy"><li>
2137         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1591">line 1591</a>
2138     </li></ul></dd>
2139
2140
2141
2142
2143
2144
2145
2146 </dl>
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160 <h5>Returns:</h5>
2161
2162
2163 <div class="param-desc">
2164     <p>The resolved type or null if not found</p>
2165 </div>
2166
2167
2168
2169 <dl>
2170     <dt>
2171         Type
2172     </dt>
2173     <dd>
2174
2175 <span class="param-type"><a href="ProtoBuf.Reflect.Namespace.html">ProtoBuf.Reflect.Namespace</a></span>
2176
2177
2178     </dd>
2179 </dl>
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190     <h4 class="name" id="toString"><span class="type-signature"></span>toString<span class="signature">(includeClass<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
2191
2192
2193
2194
2195
2196 <div class="description">
2197     <p>Returns a string representation of this Reflect object (its fully qualified name).</p>
2198 </div>
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208     <h5>Parameters:</h5>
2209
2210
2211 <table class="params">
2212     <thead>
2213     <tr>
2214
2215         <th>Name</th>
2216
2217
2218         <th>Type</th>
2219
2220
2221         <th>Attributes</th>
2222
2223
2224
2225
2226         <th class="last">Description</th>
2227     </tr>
2228     </thead>
2229
2230     <tbody>
2231
2232
2233         <tr>
2234
2235                 <td class="name"><code>includeClass</code></td>
2236
2237
2238             <td class="type">
2239
2240
2241 <span class="param-type">boolean</span>
2242
2243
2244
2245             </td>
2246
2247
2248                 <td class="attributes">
2249
2250                     &lt;optional><br>
2251
2252
2253
2254
2255
2256                 </td>
2257
2258
2259
2260
2261             <td class="description last"><p>Set to true to include the class name. Defaults to false.</p></td>
2262         </tr>
2263
2264
2265     </tbody>
2266 </table>
2267
2268
2269
2270
2271
2272
2273 <dl class="details">
2274
2275
2276
2277
2278
2279
2280     <dt class="inherited-from">Inherited From:</dt>
2281     <dd class="inherited-from"><ul class="dummy"><li>
2282         <a href="ProtoBuf.Reflect.T.html#toString">ProtoBuf.Reflect.T#toString</a>
2283     </li></ul></dd>
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305     <dt class="tag-source">Source:</dt>
2306     <dd class="tag-source"><ul class="dummy"><li>
2307         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1470">line 1470</a>
2308     </li></ul></dd>
2309
2310
2311
2312
2313
2314
2315
2316 </dl>
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330 <h5>Returns:</h5>
2331
2332
2333 <div class="param-desc">
2334     <p>String representation</p>
2335 </div>
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349 </article>
2350
2351 </section>
2352
2353
2354
2355
2356 </div>
2357
2358 <nav>
2359     <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>
2360 </nav>
2361
2362 <br class="clear">
2363
2364 <footer>
2365     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)
2366 </footer>
2367
2368 <script> prettyPrint(); </script>
2369 <script src="scripts/linenumber.js"> </script>
2370 </body>
2371 </html>