1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="utf-8">
- <title>JSDoc: Class: Namespace</title>
- <script src="scripts/prettify/prettify.js"> </script>
- <script src="scripts/prettify/lang-css.js"> </script>
- <!--[if lt IE 9]>
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
- <![endif]-->
- <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
- <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
- </head>
- <body>
- <div id="main">
- <h1 class="page-title">Class: Namespace</h1>
-
- <section>
- <header>
-
- <h2>
- <span class="ancestors"><a href="ProtoBuf.html">ProtoBuf</a><a href="ProtoBuf.Reflect.html">.Reflect</a>.</span>
-
- Namespace
- </h2>
-
-
- </header>
- <article>
- <div class="container-overview">
-
-
-
- <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>
-
- <div class="description">
- <p>Constructs a new Namespace.</p>
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
- <th>Attributes</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>builder</code></td>
-
- <td class="type">
-
-
- <span class="param-type"><a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a></span>
-
- </td>
-
- <td class="attributes">
-
-
-
- </td>
-
-
- <td class="description last"><p>Builder reference</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>parent</code></td>
-
- <td class="type">
-
-
- <span class="param-type"><a href="ProtoBuf.Reflect.Namespace.html">ProtoBuf.Reflect.Namespace</a></span>
-
- </td>
-
- <td class="attributes">
-
-
- <nullable><br>
-
-
- </td>
-
-
- <td class="description last"><p>Namespace parent</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>name</code></td>
-
- <td class="type">
-
-
- <span class="param-type">string</span>
-
- </td>
-
- <td class="attributes">
-
-
-
- </td>
-
-
- <td class="description last"><p>Namespace name</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>options</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Object.<string, *></span>
-
- </td>
-
- <td class="attributes">
-
- <optional><br>
-
-
-
- </td>
-
-
- <td class="description last"><p>Namespace options</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>syntax</code></td>
-
- <td class="type">
-
-
- <span class="param-type">string</span>
-
- </td>
-
- <td class="attributes">
-
-
- <nullable><br>
-
-
- </td>
-
-
- <td class="description last"><p>The syntax level of this definition (e.g., proto3)</p></td>
- </tr>
-
- </tbody>
- </table>
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1500">line 1500</a>
- </li></ul></dd>
-
-
-
-
- </dl>
-
- </div>
-
- <h3 class="subsection-title">Extends</h3>
-
- <ul>
- <li><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></li>
- </ul>
-
-
-
-
-
-
- <h3 class="subsection-title">Members</h3>
-
-
- <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>
- <div class="description">
- <p>Builder reference.</p>
- </div>
- <h5>Type:</h5>
- <ul>
- <li>
-
- <span class="param-type"><a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a></span>
- </li>
- </ul>
- <dl class="details">
-
-
-
- <dt class="inherited-from">Inherited From:</dt>
- <dd class="inherited-from"><ul class="dummy"><li>
- <a href="ProtoBuf.Reflect.T.html#builder">ProtoBuf.Reflect.T#builder</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1417">line 1417</a>
- </li></ul></dd>
-
-
-
-
- </dl>
-
-
- <h4 class="name" id="children"><span class="type-signature">(non-null) </span>children<span class="type-signature"> :Array.<<a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a>></span></h4>
- <div class="description">
- <p>Children inside the namespace.</p>
- </div>
- <h5>Type:</h5>
- <ul>
- <li>
-
- <span class="param-type">Array.<<a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a>></span>
- </li>
- </ul>
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1512">line 1512</a>
- </li></ul></dd>
-
-
-
-
- </dl>
-
-
- <h4 class="name" id="className"><span class="type-signature"></span>className<span class="type-signature"> :string</span></h4>
- <div class="description">
- <p>Fully qualified class name</p>
- </div>
- <h5>Type:</h5>
- <ul>
- <li>
-
- <span class="param-type">string</span>
- </li>
- </ul>
- <dl class="details">
-
-
-
-
- <dt class="tag-overrides">Overrides:</dt>
- <dd class="tag-overrides"><ul class="dummy"><li>
- <a href="ProtoBuf.Reflect.T.html#className">ProtoBuf.Reflect.T#className</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1438">line 1438</a>
- </li></ul></dd>
-
-
-
-
- </dl>
-
-
- <h4 class="name" id="name"><span class="type-signature"></span>name<span class="type-signature"> :string</span></h4>
- <div class="description">
- <p>Object name in namespace.</p>
- </div>
- <h5>Type:</h5>
- <ul>
- <li>
-
- <span class="param-type">string</span>
- </li>
- </ul>
- <dl class="details">
-
-
-
- <dt class="inherited-from">Inherited From:</dt>
- <dd class="inherited-from"><ul class="dummy"><li>
- <a href="ProtoBuf.Reflect.T.html#name">ProtoBuf.Reflect.T#name</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1431">line 1431</a>
- </li></ul></dd>
-
-
-
-
- </dl>
-
-
- <h4 class="name" id="options"><span class="type-signature">(non-null) </span>options<span class="type-signature"> :Object.<string, *></span></h4>
- <div class="description">
- <p>Options.</p>
- </div>
- <h5>Type:</h5>
- <ul>
- <li>
-
- <span class="param-type">Object.<string, *></span>
- </li>
- </ul>
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1518">line 1518</a>
- </li></ul></dd>
-
-
-
-
- </dl>
-
-
- <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>
- <div class="description">
- <p>Parent object.</p>
- </div>
- <h5>Type:</h5>
- <ul>
- <li>
-
- <span class="param-type"><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span>
- </li>
- </ul>
- <dl class="details">
-
-
-
- <dt class="inherited-from">Inherited From:</dt>
- <dd class="inherited-from"><ul class="dummy"><li>
- <a href="ProtoBuf.Reflect.T.html#parent">ProtoBuf.Reflect.T#parent</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1424">line 1424</a>
- </li></ul></dd>
-
-
-
-
- </dl>
-
-
- <h4 class="name" id="syntax"><span class="type-signature">(non-null) </span>syntax<span class="type-signature"> :string</span></h4>
- <div class="description">
- <p>Syntax level (e.g., proto2 or proto3).</p>
- </div>
- <h5>Type:</h5>
- <ul>
- <li>
-
- <span class="param-type">string</span>
- </li>
- </ul>
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1524">line 1524</a>
- </li></ul></dd>
-
-
-
-
- </dl>
-
-
-
- <h3 class="subsection-title">Methods</h3>
-
-
-
- <h4 class="name" id="addChild"><span class="type-signature"></span>addChild<span class="signature">(child)</span><span class="type-signature"></span></h4>
-
- <div class="description">
- <p>Adds a child to the namespace.</p>
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>child</code></td>
-
- <td class="type">
-
-
- <span class="param-type"><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span>
-
- </td>
-
-
- <td class="description last"><p>Child</p></td>
- </tr>
-
- </tbody>
- </table>
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1556">line 1556</a>
- </li></ul></dd>
-
-
-
-
- </dl>
- <h5>Throws:</h5>
-
- <dl>
- <dt>
- <div class="param-desc">
- <p>If the child cannot be added (duplicate)</p>
- </div>
- </dt>
- <dd></dd>
- <dt>
- <dl>
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type">Error</span>
- </dd>
- </dl>
- </dt>
- <dd></dd>
- </dl>
-
-
-
-
- <h4 class="name" id="build"><span class="type-signature"></span>build<span class="signature">()</span><span class="type-signature"> → {Object.<string, (function()|Object)>}</span></h4>
-
- <div class="description">
- <p>Builds the namespace and returns the runtime counterpart.</p>
- </div>
- <dl class="details">
-
-
-
-
- <dt class="tag-overrides">Overrides:</dt>
- <dd class="tag-overrides"><ul class="dummy"><li>
- <a href="ProtoBuf.Reflect.T.html#build">ProtoBuf.Reflect.T#build</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1648">line 1648</a>
- </li></ul></dd>
-
-
-
-
- </dl>
- <h5>Returns:</h5>
-
- <div class="param-desc">
- <p>Runtime namespace</p>
- </div>
- <dl>
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type">Object.<string, (function()|Object)></span>
- </dd>
- </dl>
-
-
-
-
- <h4 class="name" id="buildOpt"><span class="type-signature"></span>buildOpt<span class="signature">()</span><span class="type-signature"> → {Object.<string, *>}</span></h4>
-
- <div class="description">
- <p>Builds the namespace's '$options' property.</p>
- </div>
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1666">line 1666</a>
- </li></ul></dd>
-
-
-
-
- </dl>
- <h5>Returns:</h5>
-
- <dl>
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type">Object.<string, *></span>
- </dd>
- </dl>
-
-
-
-
- <h4 class="name" id="fqn"><span class="type-signature"></span>fqn<span class="signature">()</span><span class="type-signature"> → {string}</span></h4>
-
- <div class="description">
- <p>Returns the fully qualified name of this object.</p>
- </div>
- <dl class="details">
-
-
-
- <dt class="inherited-from">Inherited From:</dt>
- <dd class="inherited-from"><ul class="dummy"><li>
- <a href="ProtoBuf.Reflect.T.html#fqn">ProtoBuf.Reflect.T#fqn</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1452">line 1452</a>
- </li></ul></dd>
-
-
-
-
- </dl>
- <h5>Returns:</h5>
-
- <div class="param-desc">
- <p>Fully qualified name as of ".PATH.TO.THIS"</p>
- </div>
- <dl>
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type">string</span>
- </dd>
- </dl>
-
-
-
-
- <h4 class="name" id="getChild"><span class="type-signature"></span>getChild<span class="signature">(nameOrId)</span><span class="type-signature"> → (nullable) {<a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a>}</span></h4>
-
- <div class="description">
- <p>Gets a child by its name or id.</p>
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>nameOrId</code></td>
-
- <td class="type">
-
-
- <span class="param-type">string</span>
- |
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="description last"><p>Child name or id</p></td>
- </tr>
-
- </tbody>
- </table>
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1576">line 1576</a>
- </li></ul></dd>
-
-
-
-
- </dl>
- <h5>Returns:</h5>
-
- <div class="param-desc">
- <p>The child or null if not found</p>
- </div>
- <dl>
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type"><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span>
- </dd>
- </dl>
-
-
-
-
- <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"> → {Array.<<a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a>>}</span></h4>
-
- <div class="description">
- <p>Returns an array of the namespace's children.</p>
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
- <th>Attributes</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>type</code></td>
-
- <td class="type">
-
-
- <span class="param-type"><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span>
-
- </td>
-
- <td class="attributes">
-
- <optional><br>
-
-
-
- </td>
-
-
- <td class="description last"><p>Filter type (returns instances of this type only). Defaults to null (all children).</p></td>
- </tr>
-
- </tbody>
- </table>
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1539">line 1539</a>
- </li></ul></dd>
-
-
-
-
- </dl>
- <h5>Returns:</h5>
-
- <dl>
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type">Array.<<a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a>></span>
- </dd>
- </dl>
-
-
-
-
- <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"> → {*|Object.<string, *>}</span></h4>
-
- <div class="description">
- <p>Gets the value assigned to the option with the specified name.</p>
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
- <th>Attributes</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>name</code></td>
-
- <td class="type">
-
-
- <span class="param-type">string</span>
-
- </td>
-
- <td class="attributes">
-
- <optional><br>
-
-
-
- </td>
-
-
- <td class="description last"><p>Returns the option value if specified, otherwise all options are returned.</p></td>
- </tr>
-
- </tbody>
- </table>
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1687">line 1687</a>
- </li></ul></dd>
-
-
-
-
- </dl>
- <h5>Returns:</h5>
-
- <div class="param-desc">
- <p>null} Option value or NULL if there is no such option</p>
- </div>
- <dl>
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type">*</span>
- |
- <span class="param-type">Object.<string, *></span>
- </dd>
- </dl>
-
-
-
-
- <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"> → {string}</span></h4>
-
- <div class="description">
- <p>Determines the shortest qualified name of the specified type, if any, relative to this namespace.</p>
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>t</code></td>
-
- <td class="type">
-
-
- <span class="param-type"><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span>
-
- </td>
-
-
- <td class="description last"><p>Reflection type</p></td>
- </tr>
-
- </tbody>
- </table>
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1629">line 1629</a>
- </li></ul></dd>
-
-
-
-
- </dl>
- <h5>Returns:</h5>
-
- <div class="param-desc">
- <p>The shortest qualified name or, if there is none, the fqn</p>
- </div>
- <dl>
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type">string</span>
- </dd>
- </dl>
-
-
-
-
- <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"> → (nullable) {<a href="ProtoBuf.Reflect.Namespace.html">ProtoBuf.Reflect.Namespace</a>}</span></h4>
-
- <div class="description">
- <p>Resolves a reflect object inside of this namespace.</p>
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
- <th>Attributes</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>qn</code></td>
-
- <td class="type">
-
-
- <span class="param-type">string</span>
- |
- <span class="param-type">!Array.<string></span>
-
- </td>
-
- <td class="attributes">
-
-
-
- </td>
-
-
- <td class="description last"><p>Qualified name to resolve</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>excludeNonNamespace</code></td>
-
- <td class="type">
-
-
- <span class="param-type">boolean</span>
-
- </td>
-
- <td class="attributes">
-
- <optional><br>
-
-
-
- </td>
-
-
- <td class="description last"><p>Excludes non-namespace types, defaults to <code>false</code></p></td>
- </tr>
-
- </tbody>
- </table>
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1591">line 1591</a>
- </li></ul></dd>
-
-
-
-
- </dl>
- <h5>Returns:</h5>
-
- <div class="param-desc">
- <p>The resolved type or null if not found</p>
- </div>
- <dl>
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type"><a href="ProtoBuf.Reflect.Namespace.html">ProtoBuf.Reflect.Namespace</a></span>
- </dd>
- </dl>
-
-
-
-
- <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>
-
- <div class="description">
- <p>Returns a string representation of this Reflect object (its fully qualified name).</p>
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
- <th>Attributes</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>includeClass</code></td>
-
- <td class="type">
-
-
- <span class="param-type">boolean</span>
-
- </td>
-
- <td class="attributes">
-
- <optional><br>
-
-
-
- </td>
-
-
- <td class="description last"><p>Set to true to include the class name. Defaults to false.</p></td>
- </tr>
-
- </tbody>
- </table>
- <dl class="details">
-
-
-
- <dt class="inherited-from">Inherited From:</dt>
- <dd class="inherited-from"><ul class="dummy"><li>
- <a href="ProtoBuf.Reflect.T.html#toString">ProtoBuf.Reflect.T#toString</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1470">line 1470</a>
- </li></ul></dd>
-
-
-
-
- </dl>
- <h5>Returns:</h5>
-
- <div class="param-desc">
- <p>String representation</p>
- </div>
-
-
-
-
-
- </article>
- </section>
- </div>
- <nav>
- <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>
- </nav>
- <br class="clear">
- <footer>
- 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)
- </footer>
- <script> prettyPrint(); </script>
- <script src="scripts/linenumber.js"> </script>
- </body>
- </html>
|