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

   1 <!DOCTYPE html>
   2 <html lang="en">
   3 <head>
   4     <meta charset="utf-8">
   5     <title>JSDoc: Class: Element</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: Element</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         Element
  35         </h2>
  36
  37
  38 </header>
  39
  40 <article>
  41     <div class="container-overview">
  42
  43
  44
  45
  46
  47     <h4 class="name" id="Element"><span class="type-signature"></span>new Element<span class="signature">(type, resolvedType, isMapKey, syntax, name)</span><span class="type-signature"></span></h4>
  48
  49
  50
  51
  52
  53 <div class="description">
  54     <p>Constructs a new Element implementation that checks and converts values for a
  55 particular field type, as appropriate.</p>
  56 <p>An Element represents a single value: either the value of a singular field,
  57 or a value contained in one entry of a repeated field or map field. This
  58 class does not implement these higher-level concepts; it only encapsulates
  59 the low-level typechecking and conversion.</p>
  60 </div>
  61
  62
  63
  64
  65
  66
  67
  68
  69
  70     <h5>Parameters:</h5>
  71
  72
  73 <table class="params">
  74     <thead>
  75     <tr>
  76
  77         <th>Name</th>
  78
  79
  80         <th>Type</th>
  81
  82
  83
  84
  85
  86         <th class="last">Description</th>
  87     </tr>
  88     </thead>
  89
  90     <tbody>
  91
  92
  93         <tr>
  94
  95                 <td class="name"><code>type</code></td>
  96
  97
  98             <td class="type">
  99
 100
 101 <span class="param-type">Object</span>
 102
 103
 104
 105             </td>
 106
 107
 108
 109
 110
 111             <td class="description last"><p>Resolved data type</p></td>
 112         </tr>
 113
 114
 115
 116         <tr>
 117
 118                 <td class="name"><code>resolvedType</code></td>
 119
 120
 121             <td class="type">
 122
 123
 124 <span class="param-type"><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span>
 125 |
 126
 127 <span class="param-type">null</span>
 128
 129
 130
 131             </td>
 132
 133
 134
 135
 136
 137             <td class="description last"><p>Resolved type, if relevant
 138 (e.g. submessage field).</p></td>
 139         </tr>
 140
 141
 142
 143         <tr>
 144
 145                 <td class="name"><code>isMapKey</code></td>
 146
 147
 148             <td class="type">
 149
 150
 151 <span class="param-type">boolean</span>
 152
 153
 154
 155             </td>
 156
 157
 158
 159
 160
 161             <td class="description last"><p>Is this element a Map key? The value will be
 162 converted to string form if so.</p></td>
 163         </tr>
 164
 165
 166
 167         <tr>
 168
 169                 <td class="name"><code>syntax</code></td>
 170
 171
 172             <td class="type">
 173
 174
 175 <span class="param-type">string</span>
 176
 177
 178
 179             </td>
 180
 181
 182
 183
 184
 185             <td class="description last"><p>Syntax level of defining message type, e.g.,
 186 proto2 or proto3.</p></td>
 187         </tr>
 188
 189
 190
 191         <tr>
 192
 193                 <td class="name"><code>name</code></td>
 194
 195
 196             <td class="type">
 197
 198
 199 <span class="param-type">string</span>
 200
 201
 202
 203             </td>
 204
 205
 206
 207
 208
 209             <td class="description last"><p>Name of the field containing this element (for error
 210 messages)</p></td>
 211         </tr>
 212
 213
 214     </tbody>
 215 </table>
 216
 217
 218
 219
 220
 221
 222 <dl class="details">
 223
 224
 225
 226
 227
 228
 229
 230
 231
 232
 233
 234
 235
 236
 237
 238
 239
 240
 241
 242
 243
 244
 245
 246
 247
 248
 249     <dt class="tag-source">Source:</dt>
 250     <dd class="tag-source"><ul class="dummy"><li>
 251         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1720">line 1720</a>
 252     </li></ul></dd>
 253
 254
 255
 256
 257
 258
 259
 260 </dl>
 261
 262
 263
 264
 265
 266
 267
 268
 269
 270
 271
 272
 273
 274
 275
 276
 277
 278     </div>
 279
 280
 281
 282
 283
 284
 285
 286
 287
 288
 289
 290
 291         <h3 class="subsection-title">Members</h3>
 292
 293
 294
 295 <h4 class="name" id="isMapKey"><span class="type-signature"></span>isMapKey<span class="type-signature"> :boolean</span></h4>
 296
 297
 298
 299
 300 <div class="description">
 301     <p>Element is a map key.</p>
 302 </div>
 303
 304
 305
 306     <h5>Type:</h5>
 307     <ul>
 308         <li>
 309
 310 <span class="param-type">boolean</span>
 311
 312
 313         </li>
 314     </ul>
 315
 316
 317
 318
 319
 320 <dl class="details">
 321
 322
 323
 324
 325
 326
 327
 328
 329
 330
 331
 332
 333
 334
 335
 336
 337
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347     <dt class="tag-source">Source:</dt>
 348     <dd class="tag-source"><ul class="dummy"><li>
 349         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1738">line 1738</a>
 350     </li></ul></dd>
 351
 352
 353
 354
 355
 356
 357
 358 </dl>
 359
 360
 361
 362
 363
 364
 365
 366
 367 <h4 class="name" id="name"><span class="type-signature"></span>name<span class="type-signature"> :string</span></h4>
 368
 369
 370
 371
 372 <div class="description">
 373     <p>Name of the field containing this element (for error messages)</p>
 374 </div>
 375
 376
 377
 378     <h5>Type:</h5>
 379     <ul>
 380         <li>
 381
 382 <span class="param-type">string</span>
 383
 384
 385         </li>
 386     </ul>
 387
 388
 389
 390
 391
 392 <dl class="details">
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410
 411
 412
 413
 414
 415
 416
 417
 418
 419     <dt class="tag-source">Source:</dt>
 420     <dd class="tag-source"><ul class="dummy"><li>
 421         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1750">line 1750</a>
 422     </li></ul></dd>
 423
 424
 425
 426
 427
 428
 429
 430 </dl>
 431
 432
 433
 434
 435
 436
 437
 438
 439 <h4 class="name" id="resolvedType"><span class="type-signature"></span>resolvedType<span class="type-signature"> :<a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a>|null</span></h4>
 440
 441
 442
 443
 444 <div class="description">
 445     <p>Element type reference to submessage or enum definition, if needed.</p>
 446 </div>
 447
 448
 449
 450     <h5>Type:</h5>
 451     <ul>
 452         <li>
 453
 454 <span class="param-type"><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span>
 455 |
 456
 457 <span class="param-type">null</span>
 458
 459
 460         </li>
 461     </ul>
 462
 463
 464
 465
 466
 467 <dl class="details">
 468
 469
 470
 471
 472
 473
 474
 475
 476
 477
 478
 479
 480
 481
 482
 483
 484
 485
 486
 487
 488
 489
 490
 491
 492
 493
 494     <dt class="tag-source">Source:</dt>
 495     <dd class="tag-source"><ul class="dummy"><li>
 496         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1732">line 1732</a>
 497     </li></ul></dd>
 498
 499
 500
 501
 502
 503
 504
 505 </dl>
 506
 507
 508
 509
 510
 511
 512
 513
 514 <h4 class="name" id="syntax"><span class="type-signature"></span>syntax<span class="type-signature"> :string</span></h4>
 515
 516
 517
 518
 519 <div class="description">
 520     <p>Syntax level of defining message type, e.g., proto2 or proto3.</p>
 521 </div>
 522
 523
 524
 525     <h5>Type:</h5>
 526     <ul>
 527         <li>
 528
 529 <span class="param-type">string</span>
 530
 531
 532         </li>
 533     </ul>
 534
 535
 536
 537
 538
 539 <dl class="details">
 540
 541
 542
 543
 544
 545
 546
 547
 548
 549
 550
 551
 552
 553
 554
 555
 556
 557
 558
 559
 560
 561
 562
 563
 564
 565
 566     <dt class="tag-source">Source:</dt>
 567     <dd class="tag-source"><ul class="dummy"><li>
 568         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1744">line 1744</a>
 569     </li></ul></dd>
 570
 571
 572
 573
 574
 575
 576
 577 </dl>
 578
 579
 580
 581
 582
 583
 584
 585
 586 <h4 class="name" id="type"><span class="type-signature"></span>type<span class="type-signature"> :Object</span></h4>
 587
 588
 589
 590
 591 <div class="description">
 592     <p>Element type, as a string (e.g., int32).</p>
 593 </div>
 594
 595
 596
 597     <h5>Type:</h5>
 598     <ul>
 599         <li>
 600
 601 <span class="param-type">Object</span>
 602
 603
 604         </li>
 605     </ul>
 606
 607
 608
 609
 610
 611 <dl class="details">
 612
 613
 614
 615
 616
 617
 618
 619
 620
 621
 622
 623
 624
 625
 626
 627
 628
 629
 630
 631
 632
 633
 634
 635
 636
 637
 638     <dt class="tag-source">Source:</dt>
 639     <dd class="tag-source"><ul class="dummy"><li>
 640         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1726">line 1726</a>
 641     </li></ul></dd>
 642
 643
 644
 645
 646
 647
 648
 649 </dl>
 650
 651
 652
 653
 654
 655
 656
 657
 658
 659
 660         <h3 class="subsection-title">Methods</h3>
 661
 662
 663
 664
 665
 666
 667     <h4 class="name" id=".defaultFieldValue"><span class="type-signature">(static) </span>defaultFieldValue<span class="signature">(type)</span><span class="type-signature"> &rarr; {*}</span></h4>
 668
 669
 670
 671
 672
 673 <div class="description">
 674     <p>Returns the default value for this field in proto3.</p>
 675 </div>
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685     <h5>Parameters:</h5>
 686
 687
 688 <table class="params">
 689     <thead>
 690     <tr>
 691
 692         <th>Name</th>
 693
 694
 695         <th>Type</th>
 696
 697
 698
 699
 700
 701         <th class="last">Description</th>
 702     </tr>
 703     </thead>
 704
 705     <tbody>
 706
 707
 708         <tr>
 709
 710                 <td class="name"><code>type</code></td>
 711
 712
 713             <td class="type">
 714
 715
 716 <span class="param-type">string</span>
 717 |
 718
 719 <span class="param-type">Object</span>
 720
 721
 722
 723             </td>
 724
 725
 726
 727
 728
 729             <td class="description last"><p>the field type</p></td>
 730         </tr>
 731
 732
 733     </tbody>
 734 </table>
 735
 736
 737
 738
 739
 740
 741 <dl class="details">
 742
 743
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755
 756
 757
 758
 759
 760
 761
 762
 763
 764
 765
 766
 767
 768     <dt class="tag-source">Source:</dt>
 769     <dd class="tag-source"><ul class="dummy"><li>
 770         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1780">line 1780</a>
 771     </li></ul></dd>
 772
 773
 774
 775
 776
 777
 778
 779 </dl>
 780
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793 <h5>Returns:</h5>
 794
 795
 796 <div class="param-desc">
 797     <p>Default value</p>
 798 </div>
 799
 800
 801
 802 <dl>
 803     <dt>
 804         Type
 805     </dt>
 806     <dd>
 807
 808 <span class="param-type">*</span>
 809
 810
 811     </dd>
 812 </dl>
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824 </article>
 825
 826 </section>
 827
 828
 829
 830
 831 </div>
 832
 833 <nav>
 834     <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>
 835 </nav>
 836
 837 <br class="clear">
 838
 839 <footer>
 840     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)
 841 </footer>
 842
 843 <script> prettyPrint(); </script>
 844 <script src="scripts/linenumber.js"> </script>
 845 </body>
 846 </html>