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

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