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

   1 <!DOCTYPE html>\r
   2 <html lang="en">\r
   3 <head>\r
   4     <meta charset="utf-8">\r
   5     <title>JSDoc: Class: Element</title>\r
   6 \r
   7     <script src="scripts/prettify/prettify.js"> </script>\r
   8     <script src="scripts/prettify/lang-css.js"> </script>\r
   9     <!--[if lt IE 9]>\r
  10       <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>\r
  11     <![endif]-->\r
  12     <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">\r
  13     <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">\r
  14 </head>\r
  15 \r
  16 <body>\r
  17 \r
  18 <div id="main">\r
  19 \r
  20     <h1 class="page-title">Class: Element</h1>\r
  21 \r
  22     \r
  23 \r
  24 \r
  25 \r
  26 <section>\r
  27 \r
  28 <header>\r
  29     <h2>\r
  30         <span class="ancestors"><a href="ProtoBuf.html">ProtoBuf</a>.</span>\r
  31     \r
  32     Element\r
  33     </h2>\r
  34     \r
  35 </header>\r
  36 \r
  37 <article>\r
  38     <div class="container-overview">\r
  39     \r
  40 \r
  41     \r
  42         \r
  43 <dt>\r
  44     <h4 class="name" id="Element"><span class="type-signature"></span>new Element<span class="signature">(type, resolvedType, isMapKey, syntax)</span><span class="type-signature"></span></h4>\r
  45 \r
  46     \r
  47 </dt>\r
  48 <dd>\r
  49 \r
  50     \r
  51     <div class="description">\r
  52         <p>Constructs a new Element implementation that checks and converts values for a\r
  53 particular field type, as appropriate.</p>\r
  54 <p>An Element represents a single value: either the value of a singular field,\r
  55 or a value contained in one entry of a repeated field or map field. This\r
  56 class does not implement these higher-level concepts; it only encapsulates\r
  57 the low-level typechecking and conversion.</p>\r
  58     </div>\r
  59     \r
  60 \r
  61     \r
  62 \r
  63     \r
  64 \r
  65     \r
  66         <h5>Parameters:</h5>\r
  67         \r
  68 \r
  69 <table class="params">\r
  70     <thead>\r
  71     <tr>\r
  72         \r
  73         <th>Name</th>\r
  74         \r
  75 \r
  76         <th>Type</th>\r
  77 \r
  78         \r
  79 \r
  80         \r
  81 \r
  82         <th class="last">Description</th>\r
  83     </tr>\r
  84     </thead>\r
  85 \r
  86     <tbody>\r
  87     \r
  88 \r
  89         <tr>\r
  90             \r
  91                 <td class="name"><code>type</code></td>\r
  92             \r
  93 \r
  94             <td class="type">\r
  95             \r
  96                 \r
  97 <span class="param-type"><a href="Object.html">Object</a></span>\r
  98 \r
  99 \r
 100             \r
 101             </td>\r
 102 \r
 103             \r
 104 \r
 105             \r
 106 \r
 107             <td class="description last"><p>Resolved data type</p></td>\r
 108         </tr>\r
 109 \r
 110     \r
 111 \r
 112         <tr>\r
 113             \r
 114                 <td class="name"><code>resolvedType</code></td>\r
 115             \r
 116 \r
 117             <td class="type">\r
 118             \r
 119                 \r
 120 <span class="param-type"><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span>\r
 121 |\r
 122 \r
 123 <span class="param-type">null</span>\r
 124 \r
 125 \r
 126             \r
 127             </td>\r
 128 \r
 129             \r
 130 \r
 131             \r
 132 \r
 133             <td class="description last"><p>Resolved type, if relevant\r
 134 (e.g. submessage field).</p></td>\r
 135         </tr>\r
 136 \r
 137     \r
 138 \r
 139         <tr>\r
 140             \r
 141                 <td class="name"><code>isMapKey</code></td>\r
 142             \r
 143 \r
 144             <td class="type">\r
 145             \r
 146                 \r
 147 <span class="param-type">boolean</span>\r
 148 \r
 149 \r
 150             \r
 151             </td>\r
 152 \r
 153             \r
 154 \r
 155             \r
 156 \r
 157             <td class="description last"><p>Is this element a Map key? The value will be\r
 158 converted to string form if so.</p></td>\r
 159         </tr>\r
 160 \r
 161     \r
 162 \r
 163         <tr>\r
 164             \r
 165                 <td class="name"><code>syntax</code></td>\r
 166             \r
 167 \r
 168             <td class="type">\r
 169             \r
 170                 \r
 171 <span class="param-type">string</span>\r
 172 \r
 173 \r
 174             \r
 175             </td>\r
 176 \r
 177             \r
 178 \r
 179             \r
 180 \r
 181             <td class="description last"><p>Syntax level of defining message type, e.g.,\r
 182 proto2 or proto3.</p></td>\r
 183         </tr>\r
 184 \r
 185     \r
 186     </tbody>\r
 187 </table>\r
 188     \r
 189 \r
 190     \r
 191 <dl class="details">\r
 192     \r
 193 \r
 194     \r
 195 \r
 196     \r
 197 \r
 198     \r
 199 \r
 200     \r
 201 \r
 202     \r
 203 \r
 204     \r
 205 \r
 206     \r
 207 \r
 208     \r
 209 \r
 210     \r
 211     <dt class="tag-source">Source:</dt>\r
 212     <dd class="tag-source"><ul class="dummy"><li>\r
 213         <a href="ProtoBuf.js.html">ProtoBuf.js</a>, <a href="ProtoBuf.js.html#line3754">line 3754</a>\r
 214     </li></ul></dd>\r
 215     \r
 216 \r
 217     \r
 218 \r
 219     \r
 220 \r
 221     \r
 222 </dl>\r
 223 \r
 224 \r
 225     \r
 226 \r
 227     \r
 228 \r
 229     \r
 230 \r
 231     \r
 232 \r
 233     \r
 234 \r
 235     \r
 236 \r
 237     \r
 238 </dd>\r
 239 \r
 240     \r
 241     </div>\r
 242 \r
 243     \r
 244 \r
 245     \r
 246 \r
 247     \r
 248 \r
 249     \r
 250 \r
 251      \r
 252 \r
 253     \r
 254 \r
 255     \r
 256         <h3 class="subsection-title">Members</h3>\r
 257 \r
 258         <dl>\r
 259             \r
 260 <dt>\r
 261     <h4 class="name" id="isMapKey"><span class="type-signature"></span>isMapKey<span class="type-signature"> :boolean</span></h4>\r
 262 \r
 263     \r
 264 </dt>\r
 265 <dd>\r
 266     \r
 267     <div class="description">\r
 268         <p>Element is a map key.</p>\r
 269     </div>\r
 270     \r
 271 \r
 272     \r
 273         <h5>Type:</h5>\r
 274         <ul>\r
 275             <li>\r
 276                 \r
 277 <span class="param-type">boolean</span>\r
 278 \r
 279 \r
 280             </li>\r
 281         </ul>\r
 282     \r
 283 \r
 284     \r
 285 <dl class="details">\r
 286     \r
 287 \r
 288     \r
 289 \r
 290     \r
 291 \r
 292     \r
 293 \r
 294     \r
 295 \r
 296     \r
 297 \r
 298     \r
 299 \r
 300     \r
 301 \r
 302     \r
 303 \r
 304     \r
 305     <dt class="tag-source">Source:</dt>\r
 306     <dd class="tag-source"><ul class="dummy"><li>\r
 307         <a href="ProtoBuf.js.html">ProtoBuf.js</a>, <a href="ProtoBuf.js.html#line3771">line 3771</a>\r
 308     </li></ul></dd>\r
 309     \r
 310 \r
 311     \r
 312 \r
 313     \r
 314 \r
 315     \r
 316 </dl>\r
 317 \r
 318 \r
 319     \r
 320 \r
 321     \r
 322 </dd>\r
 323 \r
 324         \r
 325             \r
 326 <dt>\r
 327     <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>\r
 328 \r
 329     \r
 330 </dt>\r
 331 <dd>\r
 332     \r
 333     <div class="description">\r
 334         <p>Element type reference to submessage or enum definition, if needed.</p>\r
 335     </div>\r
 336     \r
 337 \r
 338     \r
 339         <h5>Type:</h5>\r
 340         <ul>\r
 341             <li>\r
 342                 \r
 343 <span class="param-type"><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span>\r
 344 |\r
 345 \r
 346 <span class="param-type">null</span>\r
 347 \r
 348 \r
 349             </li>\r
 350         </ul>\r
 351     \r
 352 \r
 353     \r
 354 <dl class="details">\r
 355     \r
 356 \r
 357     \r
 358 \r
 359     \r
 360 \r
 361     \r
 362 \r
 363     \r
 364 \r
 365     \r
 366 \r
 367     \r
 368 \r
 369     \r
 370 \r
 371     \r
 372 \r
 373     \r
 374     <dt class="tag-source">Source:</dt>\r
 375     <dd class="tag-source"><ul class="dummy"><li>\r
 376         <a href="ProtoBuf.js.html">ProtoBuf.js</a>, <a href="ProtoBuf.js.html#line3765">line 3765</a>\r
 377     </li></ul></dd>\r
 378     \r
 379 \r
 380     \r
 381 \r
 382     \r
 383 \r
 384     \r
 385 </dl>\r
 386 \r
 387 \r
 388     \r
 389 \r
 390     \r
 391 </dd>\r
 392 \r
 393         \r
 394             \r
 395 <dt>\r
 396     <h4 class="name" id="syntax"><span class="type-signature"></span>syntax<span class="type-signature"> :string</span></h4>\r
 397 \r
 398     \r
 399 </dt>\r
 400 <dd>\r
 401     \r
 402     <div class="description">\r
 403         <p>Syntax level of defining message type, e.g., proto2 or proto3.</p>\r
 404     </div>\r
 405     \r
 406 \r
 407     \r
 408         <h5>Type:</h5>\r
 409         <ul>\r
 410             <li>\r
 411                 \r
 412 <span class="param-type">string</span>\r
 413 \r
 414 \r
 415             </li>\r
 416         </ul>\r
 417     \r
 418 \r
 419     \r
 420 <dl class="details">\r
 421     \r
 422 \r
 423     \r
 424 \r
 425     \r
 426 \r
 427     \r
 428 \r
 429     \r
 430 \r
 431     \r
 432 \r
 433     \r
 434 \r
 435     \r
 436 \r
 437     \r
 438 \r
 439     \r
 440     <dt class="tag-source">Source:</dt>\r
 441     <dd class="tag-source"><ul class="dummy"><li>\r
 442         <a href="ProtoBuf.js.html">ProtoBuf.js</a>, <a href="ProtoBuf.js.html#line3777">line 3777</a>\r
 443     </li></ul></dd>\r
 444     \r
 445 \r
 446     \r
 447 \r
 448     \r
 449 \r
 450     \r
 451 </dl>\r
 452 \r
 453 \r
 454     \r
 455 \r
 456     \r
 457 </dd>\r
 458 \r
 459         \r
 460             \r
 461 <dt>\r
 462     <h4 class="name" id="type"><span class="type-signature"></span>type<span class="type-signature"> :<a href="Object.html">Object</a></span></h4>\r
 463 \r
 464     \r
 465 </dt>\r
 466 <dd>\r
 467     \r
 468     <div class="description">\r
 469         <p>Element type, as a string (e.g., int32).</p>\r
 470     </div>\r
 471     \r
 472 \r
 473     \r
 474         <h5>Type:</h5>\r
 475         <ul>\r
 476             <li>\r
 477                 \r
 478 <span class="param-type"><a href="Object.html">Object</a></span>\r
 479 \r
 480 \r
 481             </li>\r
 482         </ul>\r
 483     \r
 484 \r
 485     \r
 486 <dl class="details">\r
 487     \r
 488 \r
 489     \r
 490 \r
 491     \r
 492 \r
 493     \r
 494 \r
 495     \r
 496 \r
 497     \r
 498 \r
 499     \r
 500 \r
 501     \r
 502 \r
 503     \r
 504 \r
 505     \r
 506     <dt class="tag-source">Source:</dt>\r
 507     <dd class="tag-source"><ul class="dummy"><li>\r
 508         <a href="ProtoBuf.js.html">ProtoBuf.js</a>, <a href="ProtoBuf.js.html#line3759">line 3759</a>\r
 509     </li></ul></dd>\r
 510     \r
 511 \r
 512     \r
 513 \r
 514     \r
 515 \r
 516     \r
 517 </dl>\r
 518 \r
 519 \r
 520     \r
 521 \r
 522     \r
 523 </dd>\r
 524 \r
 525         </dl>\r
 526     \r
 527 \r
 528     \r
 529 \r
 530     \r
 531 \r
 532     \r
 533 </article>\r
 534 \r
 535 </section>\r
 536 \r
 537 \r
 538 \r
 539 \r
 540 </div>\r
 541 \r
 542 <nav>\r
 543     <h2><a href="index.html">Index</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.Element.html">Element</a></li><li><a href="ProtoBuf.Map.html">Map</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>\r
 544 </nav>\r
 545 \r
 546 <br clear="both">\r
 547 \r
 548 <footer>\r
 549     Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Mon Jun 01 2015 01:15:14 GMT+0200 (Mitteleuropäische Sommerzeit)\r
 550 </footer>\r
 551 \r
 552 <script> prettyPrint(); </script>\r
 553 <script src="scripts/linenumber.js"> </script>\r
 554 </body>\r
 555 </html>