ProtoBuf.Reflect.Namespace.html 29 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Class: Namespace</title>
  6. <script src="scripts/prettify/prettify.js"> </script>
  7. <script src="scripts/prettify/lang-css.js"> </script>
  8. <!--[if lt IE 9]>
  9. <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  10. <![endif]-->
  11. <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
  12. <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
  13. </head>
  14. <body>
  15. <div id="main">
  16. <h1 class="page-title">Class: Namespace</h1>
  17. <section>
  18. <header>
  19. <h2>
  20. <span class="ancestors"><a href="ProtoBuf.html">ProtoBuf</a><a href="ProtoBuf.Reflect.html">.Reflect</a>.</span>
  21. Namespace
  22. </h2>
  23. </header>
  24. <article>
  25. <div class="container-overview">
  26. <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>
  27. <div class="description">
  28. <p>Constructs a new Namespace.</p>
  29. </div>
  30. <h5>Parameters:</h5>
  31. <table class="params">
  32. <thead>
  33. <tr>
  34. <th>Name</th>
  35. <th>Type</th>
  36. <th>Attributes</th>
  37. <th class="last">Description</th>
  38. </tr>
  39. </thead>
  40. <tbody>
  41. <tr>
  42. <td class="name"><code>builder</code></td>
  43. <td class="type">
  44. <span class="param-type"><a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a></span>
  45. </td>
  46. <td class="attributes">
  47. </td>
  48. <td class="description last"><p>Builder reference</p></td>
  49. </tr>
  50. <tr>
  51. <td class="name"><code>parent</code></td>
  52. <td class="type">
  53. <span class="param-type"><a href="ProtoBuf.Reflect.Namespace.html">ProtoBuf.Reflect.Namespace</a></span>
  54. </td>
  55. <td class="attributes">
  56. &lt;nullable><br>
  57. </td>
  58. <td class="description last"><p>Namespace parent</p></td>
  59. </tr>
  60. <tr>
  61. <td class="name"><code>name</code></td>
  62. <td class="type">
  63. <span class="param-type">string</span>
  64. </td>
  65. <td class="attributes">
  66. </td>
  67. <td class="description last"><p>Namespace name</p></td>
  68. </tr>
  69. <tr>
  70. <td class="name"><code>options</code></td>
  71. <td class="type">
  72. <span class="param-type">Object.&lt;string, *></span>
  73. </td>
  74. <td class="attributes">
  75. &lt;optional><br>
  76. </td>
  77. <td class="description last"><p>Namespace options</p></td>
  78. </tr>
  79. <tr>
  80. <td class="name"><code>syntax</code></td>
  81. <td class="type">
  82. <span class="param-type">string</span>
  83. </td>
  84. <td class="attributes">
  85. &lt;nullable><br>
  86. </td>
  87. <td class="description last"><p>The syntax level of this definition (e.g., proto3)</p></td>
  88. </tr>
  89. </tbody>
  90. </table>
  91. <dl class="details">
  92. <dt class="tag-source">Source:</dt>
  93. <dd class="tag-source"><ul class="dummy"><li>
  94. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1500">line 1500</a>
  95. </li></ul></dd>
  96. </dl>
  97. </div>
  98. <h3 class="subsection-title">Extends</h3>
  99. <ul>
  100. <li><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></li>
  101. </ul>
  102. <h3 class="subsection-title">Members</h3>
  103. <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>
  104. <div class="description">
  105. <p>Builder reference.</p>
  106. </div>
  107. <h5>Type:</h5>
  108. <ul>
  109. <li>
  110. <span class="param-type"><a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a></span>
  111. </li>
  112. </ul>
  113. <dl class="details">
  114. <dt class="inherited-from">Inherited From:</dt>
  115. <dd class="inherited-from"><ul class="dummy"><li>
  116. <a href="ProtoBuf.Reflect.T.html#builder">ProtoBuf.Reflect.T#builder</a>
  117. </li></ul></dd>
  118. <dt class="tag-source">Source:</dt>
  119. <dd class="tag-source"><ul class="dummy"><li>
  120. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1417">line 1417</a>
  121. </li></ul></dd>
  122. </dl>
  123. <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>
  124. <div class="description">
  125. <p>Children inside the namespace.</p>
  126. </div>
  127. <h5>Type:</h5>
  128. <ul>
  129. <li>
  130. <span class="param-type">Array.&lt;<a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a>></span>
  131. </li>
  132. </ul>
  133. <dl class="details">
  134. <dt class="tag-source">Source:</dt>
  135. <dd class="tag-source"><ul class="dummy"><li>
  136. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1512">line 1512</a>
  137. </li></ul></dd>
  138. </dl>
  139. <h4 class="name" id="className"><span class="type-signature"></span>className<span class="type-signature"> :string</span></h4>
  140. <div class="description">
  141. <p>Fully qualified class name</p>
  142. </div>
  143. <h5>Type:</h5>
  144. <ul>
  145. <li>
  146. <span class="param-type">string</span>
  147. </li>
  148. </ul>
  149. <dl class="details">
  150. <dt class="tag-overrides">Overrides:</dt>
  151. <dd class="tag-overrides"><ul class="dummy"><li>
  152. <a href="ProtoBuf.Reflect.T.html#className">ProtoBuf.Reflect.T#className</a>
  153. </li></ul></dd>
  154. <dt class="tag-source">Source:</dt>
  155. <dd class="tag-source"><ul class="dummy"><li>
  156. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1438">line 1438</a>
  157. </li></ul></dd>
  158. </dl>
  159. <h4 class="name" id="name"><span class="type-signature"></span>name<span class="type-signature"> :string</span></h4>
  160. <div class="description">
  161. <p>Object name in namespace.</p>
  162. </div>
  163. <h5>Type:</h5>
  164. <ul>
  165. <li>
  166. <span class="param-type">string</span>
  167. </li>
  168. </ul>
  169. <dl class="details">
  170. <dt class="inherited-from">Inherited From:</dt>
  171. <dd class="inherited-from"><ul class="dummy"><li>
  172. <a href="ProtoBuf.Reflect.T.html#name">ProtoBuf.Reflect.T#name</a>
  173. </li></ul></dd>
  174. <dt class="tag-source">Source:</dt>
  175. <dd class="tag-source"><ul class="dummy"><li>
  176. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1431">line 1431</a>
  177. </li></ul></dd>
  178. </dl>
  179. <h4 class="name" id="options"><span class="type-signature">(non-null) </span>options<span class="type-signature"> :Object.&lt;string, *></span></h4>
  180. <div class="description">
  181. <p>Options.</p>
  182. </div>
  183. <h5>Type:</h5>
  184. <ul>
  185. <li>
  186. <span class="param-type">Object.&lt;string, *></span>
  187. </li>
  188. </ul>
  189. <dl class="details">
  190. <dt class="tag-source">Source:</dt>
  191. <dd class="tag-source"><ul class="dummy"><li>
  192. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1518">line 1518</a>
  193. </li></ul></dd>
  194. </dl>
  195. <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>
  196. <div class="description">
  197. <p>Parent object.</p>
  198. </div>
  199. <h5>Type:</h5>
  200. <ul>
  201. <li>
  202. <span class="param-type"><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span>
  203. </li>
  204. </ul>
  205. <dl class="details">
  206. <dt class="inherited-from">Inherited From:</dt>
  207. <dd class="inherited-from"><ul class="dummy"><li>
  208. <a href="ProtoBuf.Reflect.T.html#parent">ProtoBuf.Reflect.T#parent</a>
  209. </li></ul></dd>
  210. <dt class="tag-source">Source:</dt>
  211. <dd class="tag-source"><ul class="dummy"><li>
  212. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1424">line 1424</a>
  213. </li></ul></dd>
  214. </dl>
  215. <h4 class="name" id="syntax"><span class="type-signature">(non-null) </span>syntax<span class="type-signature"> :string</span></h4>
  216. <div class="description">
  217. <p>Syntax level (e.g., proto2 or proto3).</p>
  218. </div>
  219. <h5>Type:</h5>
  220. <ul>
  221. <li>
  222. <span class="param-type">string</span>
  223. </li>
  224. </ul>
  225. <dl class="details">
  226. <dt class="tag-source">Source:</dt>
  227. <dd class="tag-source"><ul class="dummy"><li>
  228. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1524">line 1524</a>
  229. </li></ul></dd>
  230. </dl>
  231. <h3 class="subsection-title">Methods</h3>
  232. <h4 class="name" id="addChild"><span class="type-signature"></span>addChild<span class="signature">(child)</span><span class="type-signature"></span></h4>
  233. <div class="description">
  234. <p>Adds a child to the namespace.</p>
  235. </div>
  236. <h5>Parameters:</h5>
  237. <table class="params">
  238. <thead>
  239. <tr>
  240. <th>Name</th>
  241. <th>Type</th>
  242. <th class="last">Description</th>
  243. </tr>
  244. </thead>
  245. <tbody>
  246. <tr>
  247. <td class="name"><code>child</code></td>
  248. <td class="type">
  249. <span class="param-type"><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span>
  250. </td>
  251. <td class="description last"><p>Child</p></td>
  252. </tr>
  253. </tbody>
  254. </table>
  255. <dl class="details">
  256. <dt class="tag-source">Source:</dt>
  257. <dd class="tag-source"><ul class="dummy"><li>
  258. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1556">line 1556</a>
  259. </li></ul></dd>
  260. </dl>
  261. <h5>Throws:</h5>
  262. <dl>
  263. <dt>
  264. <div class="param-desc">
  265. <p>If the child cannot be added (duplicate)</p>
  266. </div>
  267. </dt>
  268. <dd></dd>
  269. <dt>
  270. <dl>
  271. <dt>
  272. Type
  273. </dt>
  274. <dd>
  275. <span class="param-type">Error</span>
  276. </dd>
  277. </dl>
  278. </dt>
  279. <dd></dd>
  280. </dl>
  281. <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>
  282. <div class="description">
  283. <p>Builds the namespace and returns the runtime counterpart.</p>
  284. </div>
  285. <dl class="details">
  286. <dt class="tag-overrides">Overrides:</dt>
  287. <dd class="tag-overrides"><ul class="dummy"><li>
  288. <a href="ProtoBuf.Reflect.T.html#build">ProtoBuf.Reflect.T#build</a>
  289. </li></ul></dd>
  290. <dt class="tag-source">Source:</dt>
  291. <dd class="tag-source"><ul class="dummy"><li>
  292. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1648">line 1648</a>
  293. </li></ul></dd>
  294. </dl>
  295. <h5>Returns:</h5>
  296. <div class="param-desc">
  297. <p>Runtime namespace</p>
  298. </div>
  299. <dl>
  300. <dt>
  301. Type
  302. </dt>
  303. <dd>
  304. <span class="param-type">Object.&lt;string, (function()|Object)></span>
  305. </dd>
  306. </dl>
  307. <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>
  308. <div class="description">
  309. <p>Builds the namespace's '$options' property.</p>
  310. </div>
  311. <dl class="details">
  312. <dt class="tag-source">Source:</dt>
  313. <dd class="tag-source"><ul class="dummy"><li>
  314. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1666">line 1666</a>
  315. </li></ul></dd>
  316. </dl>
  317. <h5>Returns:</h5>
  318. <dl>
  319. <dt>
  320. Type
  321. </dt>
  322. <dd>
  323. <span class="param-type">Object.&lt;string, *></span>
  324. </dd>
  325. </dl>
  326. <h4 class="name" id="fqn"><span class="type-signature"></span>fqn<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
  327. <div class="description">
  328. <p>Returns the fully qualified name of this object.</p>
  329. </div>
  330. <dl class="details">
  331. <dt class="inherited-from">Inherited From:</dt>
  332. <dd class="inherited-from"><ul class="dummy"><li>
  333. <a href="ProtoBuf.Reflect.T.html#fqn">ProtoBuf.Reflect.T#fqn</a>
  334. </li></ul></dd>
  335. <dt class="tag-source">Source:</dt>
  336. <dd class="tag-source"><ul class="dummy"><li>
  337. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1452">line 1452</a>
  338. </li></ul></dd>
  339. </dl>
  340. <h5>Returns:</h5>
  341. <div class="param-desc">
  342. <p>Fully qualified name as of &quot;.PATH.TO.THIS&quot;</p>
  343. </div>
  344. <dl>
  345. <dt>
  346. Type
  347. </dt>
  348. <dd>
  349. <span class="param-type">string</span>
  350. </dd>
  351. </dl>
  352. <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>
  353. <div class="description">
  354. <p>Gets a child by its name or id.</p>
  355. </div>
  356. <h5>Parameters:</h5>
  357. <table class="params">
  358. <thead>
  359. <tr>
  360. <th>Name</th>
  361. <th>Type</th>
  362. <th class="last">Description</th>
  363. </tr>
  364. </thead>
  365. <tbody>
  366. <tr>
  367. <td class="name"><code>nameOrId</code></td>
  368. <td class="type">
  369. <span class="param-type">string</span>
  370. |
  371. <span class="param-type">number</span>
  372. </td>
  373. <td class="description last"><p>Child name or id</p></td>
  374. </tr>
  375. </tbody>
  376. </table>
  377. <dl class="details">
  378. <dt class="tag-source">Source:</dt>
  379. <dd class="tag-source"><ul class="dummy"><li>
  380. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1576">line 1576</a>
  381. </li></ul></dd>
  382. </dl>
  383. <h5>Returns:</h5>
  384. <div class="param-desc">
  385. <p>The child or null if not found</p>
  386. </div>
  387. <dl>
  388. <dt>
  389. Type
  390. </dt>
  391. <dd>
  392. <span class="param-type"><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span>
  393. </dd>
  394. </dl>
  395. <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>
  396. <div class="description">
  397. <p>Returns an array of the namespace's children.</p>
  398. </div>
  399. <h5>Parameters:</h5>
  400. <table class="params">
  401. <thead>
  402. <tr>
  403. <th>Name</th>
  404. <th>Type</th>
  405. <th>Attributes</th>
  406. <th class="last">Description</th>
  407. </tr>
  408. </thead>
  409. <tbody>
  410. <tr>
  411. <td class="name"><code>type</code></td>
  412. <td class="type">
  413. <span class="param-type"><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span>
  414. </td>
  415. <td class="attributes">
  416. &lt;optional><br>
  417. </td>
  418. <td class="description last"><p>Filter type (returns instances of this type only). Defaults to null (all children).</p></td>
  419. </tr>
  420. </tbody>
  421. </table>
  422. <dl class="details">
  423. <dt class="tag-source">Source:</dt>
  424. <dd class="tag-source"><ul class="dummy"><li>
  425. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1539">line 1539</a>
  426. </li></ul></dd>
  427. </dl>
  428. <h5>Returns:</h5>
  429. <dl>
  430. <dt>
  431. Type
  432. </dt>
  433. <dd>
  434. <span class="param-type">Array.&lt;<a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a>></span>
  435. </dd>
  436. </dl>
  437. <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>
  438. <div class="description">
  439. <p>Gets the value assigned to the option with the specified name.</p>
  440. </div>
  441. <h5>Parameters:</h5>
  442. <table class="params">
  443. <thead>
  444. <tr>
  445. <th>Name</th>
  446. <th>Type</th>
  447. <th>Attributes</th>
  448. <th class="last">Description</th>
  449. </tr>
  450. </thead>
  451. <tbody>
  452. <tr>
  453. <td class="name"><code>name</code></td>
  454. <td class="type">
  455. <span class="param-type">string</span>
  456. </td>
  457. <td class="attributes">
  458. &lt;optional><br>
  459. </td>
  460. <td class="description last"><p>Returns the option value if specified, otherwise all options are returned.</p></td>
  461. </tr>
  462. </tbody>
  463. </table>
  464. <dl class="details">
  465. <dt class="tag-source">Source:</dt>
  466. <dd class="tag-source"><ul class="dummy"><li>
  467. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1687">line 1687</a>
  468. </li></ul></dd>
  469. </dl>
  470. <h5>Returns:</h5>
  471. <div class="param-desc">
  472. <p>null} Option value or NULL if there is no such option</p>
  473. </div>
  474. <dl>
  475. <dt>
  476. Type
  477. </dt>
  478. <dd>
  479. <span class="param-type">*</span>
  480. |
  481. <span class="param-type">Object.&lt;string, *></span>
  482. </dd>
  483. </dl>
  484. <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>
  485. <div class="description">
  486. <p>Determines the shortest qualified name of the specified type, if any, relative to this namespace.</p>
  487. </div>
  488. <h5>Parameters:</h5>
  489. <table class="params">
  490. <thead>
  491. <tr>
  492. <th>Name</th>
  493. <th>Type</th>
  494. <th class="last">Description</th>
  495. </tr>
  496. </thead>
  497. <tbody>
  498. <tr>
  499. <td class="name"><code>t</code></td>
  500. <td class="type">
  501. <span class="param-type"><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span>
  502. </td>
  503. <td class="description last"><p>Reflection type</p></td>
  504. </tr>
  505. </tbody>
  506. </table>
  507. <dl class="details">
  508. <dt class="tag-source">Source:</dt>
  509. <dd class="tag-source"><ul class="dummy"><li>
  510. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1629">line 1629</a>
  511. </li></ul></dd>
  512. </dl>
  513. <h5>Returns:</h5>
  514. <div class="param-desc">
  515. <p>The shortest qualified name or, if there is none, the fqn</p>
  516. </div>
  517. <dl>
  518. <dt>
  519. Type
  520. </dt>
  521. <dd>
  522. <span class="param-type">string</span>
  523. </dd>
  524. </dl>
  525. <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>
  526. <div class="description">
  527. <p>Resolves a reflect object inside of this namespace.</p>
  528. </div>
  529. <h5>Parameters:</h5>
  530. <table class="params">
  531. <thead>
  532. <tr>
  533. <th>Name</th>
  534. <th>Type</th>
  535. <th>Attributes</th>
  536. <th class="last">Description</th>
  537. </tr>
  538. </thead>
  539. <tbody>
  540. <tr>
  541. <td class="name"><code>qn</code></td>
  542. <td class="type">
  543. <span class="param-type">string</span>
  544. |
  545. <span class="param-type">!Array.&lt;string></span>
  546. </td>
  547. <td class="attributes">
  548. </td>
  549. <td class="description last"><p>Qualified name to resolve</p></td>
  550. </tr>
  551. <tr>
  552. <td class="name"><code>excludeNonNamespace</code></td>
  553. <td class="type">
  554. <span class="param-type">boolean</span>
  555. </td>
  556. <td class="attributes">
  557. &lt;optional><br>
  558. </td>
  559. <td class="description last"><p>Excludes non-namespace types, defaults to <code>false</code></p></td>
  560. </tr>
  561. </tbody>
  562. </table>
  563. <dl class="details">
  564. <dt class="tag-source">Source:</dt>
  565. <dd class="tag-source"><ul class="dummy"><li>
  566. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1591">line 1591</a>
  567. </li></ul></dd>
  568. </dl>
  569. <h5>Returns:</h5>
  570. <div class="param-desc">
  571. <p>The resolved type or null if not found</p>
  572. </div>
  573. <dl>
  574. <dt>
  575. Type
  576. </dt>
  577. <dd>
  578. <span class="param-type"><a href="ProtoBuf.Reflect.Namespace.html">ProtoBuf.Reflect.Namespace</a></span>
  579. </dd>
  580. </dl>
  581. <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>
  582. <div class="description">
  583. <p>Returns a string representation of this Reflect object (its fully qualified name).</p>
  584. </div>
  585. <h5>Parameters:</h5>
  586. <table class="params">
  587. <thead>
  588. <tr>
  589. <th>Name</th>
  590. <th>Type</th>
  591. <th>Attributes</th>
  592. <th class="last">Description</th>
  593. </tr>
  594. </thead>
  595. <tbody>
  596. <tr>
  597. <td class="name"><code>includeClass</code></td>
  598. <td class="type">
  599. <span class="param-type">boolean</span>
  600. </td>
  601. <td class="attributes">
  602. &lt;optional><br>
  603. </td>
  604. <td class="description last"><p>Set to true to include the class name. Defaults to false.</p></td>
  605. </tr>
  606. </tbody>
  607. </table>
  608. <dl class="details">
  609. <dt class="inherited-from">Inherited From:</dt>
  610. <dd class="inherited-from"><ul class="dummy"><li>
  611. <a href="ProtoBuf.Reflect.T.html#toString">ProtoBuf.Reflect.T#toString</a>
  612. </li></ul></dd>
  613. <dt class="tag-source">Source:</dt>
  614. <dd class="tag-source"><ul class="dummy"><li>
  615. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1470">line 1470</a>
  616. </li></ul></dd>
  617. </dl>
  618. <h5>Returns:</h5>
  619. <div class="param-desc">
  620. <p>String representation</p>
  621. </div>
  622. </article>
  623. </section>
  624. </div>
  625. <nav>
  626. <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>
  627. </nav>
  628. <br class="clear">
  629. <footer>
  630. 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)
  631. </footer>
  632. <script> prettyPrint(); </script>
  633. <script src="scripts/linenumber.js"> </script>
  634. </body>
  635. </html>