protobufjs 3.6.0 → 3.8.2

package/docs/ProtoBuf.html

@@ -23,26 +23,34 @@
 
 
 
+
 <section>
 
 <header>
-    <h2>
-    ProtoBuf
-    </h2>
+    
+        <h2>
+        ProtoBuf
+        </h2>
+        
     
 </header>
 
 <article>
     <div class="container-overview">
     
-
-    
         
             <div class="description"><p>The ProtoBuf namespace.</p></div>
         
 
         
+
+
 <dl class="details">
+
+    
+
+    
+
     
 
     
@@ -85,8 +93,6 @@
     
 
     
-
-    
         <h3 class="subsection-title">Classes</h3>
 
         <dl>
@@ -101,13 +107,13 @@
         <h3 class="subsection-title">Namespaces</h3>
 
         <dl>
-            <dt><a href="namespaces.html#ProtoBuf.DotProto"><a href="ProtoBuf.DotProto.html">DotProto</a></a></dt>
+            <dt><a href="ProtoBuf.DotProto.html">DotProto</a></dt>
             <dd></dd>
         
-            <dt><a href="namespaces.html#ProtoBuf.Reflect"><a href="ProtoBuf.Reflect.html">Reflect</a></a></dt>
+            <dt><a href="ProtoBuf.Reflect.html">Reflect</a></dt>
             <dd></dd>
         
-            <dt><a href="namespaces.html#ProtoBuf.Util"><a href="ProtoBuf.Util.html">Util</a></a></dt>
+            <dt><a href="ProtoBuf.Util.html">Util</a></dt>
             <dd></dd>
         </dl>
     
@@ -138,7 +144,14 @@
     
 
     
+
+
 <dl class="details">
+
+    
+
+    
+
     
 
     
@@ -205,7 +218,14 @@
     
 
     
+
+
 <dl class="details">
+
+    
+
+    
+
     
 
     
@@ -271,7 +291,14 @@
     
 
     
+
+
 <dl class="details">
+
+    
+
+    
+
     
 
     
@@ -337,7 +364,14 @@
     
 
     
+
+
 <dl class="details">
+
+    
+
+    
+
     
 
     
@@ -379,7 +413,7 @@
         
             
 <dt>
-    <h4 class="name" id="Lang"><span class="type-signature">(static, non-null) </span>Lang<span class="type-signature"> :<a href="Object.html">Object</a>.&lt;string, string, RegExp></span></h4>
+    <h4 class="name" id="Lang"><span class="type-signature">(static, non-null) </span>Lang<span class="type-signature"> :<a href="Object.html">Object</a>.&lt;string, (string|!RegExp)></span></h4>
 
     
 </dt>
@@ -395,7 +429,7 @@
         <ul>
             <li>
                 
-<span class="param-type"><a href="Object.html">Object</a>.&lt;string, string, RegExp></span>
+<span class="param-type"><a href="Object.html">Object</a>.&lt;string, (string|!RegExp)></span>
 
 
             </li>
@@ -403,7 +437,14 @@
     
 
     
+
+
 <dl class="details">
+
+    
+
+    
+
     
 
     
@@ -465,7 +506,14 @@
     
 
     
+
+
 <dl class="details">
+
+    
+
+    
+
     
 
     
@@ -531,7 +579,14 @@
     
 
     
+
+
 <dl class="details">
+
+    
+
+    
+
     
 
     
@@ -598,7 +653,14 @@
     
 
     
+
+
 <dl class="details">
+
+    
+
+    
+
     
 
     
@@ -640,7 +702,7 @@
         
             
 <dt>
-    <h4 class="name" id="TYPES"><span class="type-signature">(static, constant) </span>TYPES<span class="type-signature"> :<a href="Object.html">Object</a>.&lt;string, <a href="Object.html">Object</a>></span></h4>
+    <h4 class="name" id="TYPES"><span class="type-signature">(static, constant) </span>TYPES<span class="type-signature"> :<a href="Object.html">Object</a>.&lt;string, {name: string, wireType: number}></span></h4>
 
     
 </dt>
@@ -656,7 +718,7 @@
         <ul>
             <li>
                 
-<span class="param-type"><a href="Object.html">Object</a>.&lt;string, <a href="Object.html">Object</a>></span>
+<span class="param-type"><a href="Object.html">Object</a>.&lt;string, {name: string, wireType: number}></span>
 
 
             </li>
@@ -664,7 +726,14 @@
     
 
     
+
+
 <dl class="details">
+
+    
+
+    
+
     
 
     
@@ -730,7 +799,14 @@
     
 
     
+
+
 <dl class="details">
+
+    
+
+    
+
     
 
     
@@ -796,7 +872,14 @@
     
 
     
+
+
 <dl class="details">
+
+    
+
+    
+
     
 
     
@@ -862,7 +945,14 @@
     
 
     
+
+
 <dl class="details">
+
+    
+
+    
+
     
 
     
@@ -928,7 +1018,14 @@
     
 
     
+
+
 <dl class="details">
+
+    
+
+    
+
     
 
     
@@ -994,7 +1091,14 @@
     
 
     
+
+
 <dl class="details">
+
+    
+
+    
+
     
 
     
@@ -1060,7 +1164,14 @@
     
 
     
+
+
 <dl class="details">
+
+    
+
+    
+
     
 
     
@@ -1126,7 +1237,14 @@
     
 
     
+
+
 <dl class="details">
+
+    
+
+    
+
     
 
     
@@ -1192,7 +1310,14 @@
     
 
     
+
+
 <dl class="details">
+
+    
+
+    
+
     
 
     
@@ -1240,8 +1365,10 @@
         <dl>
             
 <dt>
-    <h4 class="name" id="loadJson"><span class="type-signature">(static) </span>loadJson<span class="signature">(json, builder<span class="signature-attributes">opt</span>, filename<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a>}</span></h4>
+    
+        <h4 class="name" id="loadJson"><span class="type-signature">(static) </span>loadJson<span class="signature">(json, builder<span class="signature-attributes">opt</span>, filename<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a>}</span></h4>
 
+        
     
 </dt>
 <dd>
@@ -1257,6 +1384,8 @@
     
 
     
+
+    
         <h5>Parameters:</h5>
         
 
@@ -1395,7 +1524,14 @@
     
 
     
+
+
 <dl class="details">
+
+    
+
+    
+
     
 
     
@@ -1417,7 +1553,7 @@
     
     <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#line4073">line 4073</a>
+        <a href="ProtoBuf.js.html">ProtoBuf.js</a>, <a href="ProtoBuf.js.html#line4278">line 4278</a>
     </li></ul></dd>
     
 
@@ -1496,8 +1632,10 @@
         
             
 <dt>
-    <h4 class="name" id="loadJsonFile"><span class="type-signature">(static) </span>loadJsonFile<span class="signature">(filename, callback<span class="signature-attributes">opt</span>, builder<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a>|undefined}</span></h4>
+    
+        <h4 class="name" id="loadJsonFile"><span class="type-signature">(static) </span>loadJsonFile<span class="signature">(filename, callback<span class="signature-attributes">opt</span>, builder<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a>|undefined}</span></h4>
 
+        
     
 </dt>
 <dd>
@@ -1513,6 +1651,8 @@
     
 
     
+
+    
         <h5>Parameters:</h5>
         
 
@@ -1645,7 +1785,14 @@
     
 
     
+
+
 <dl class="details">
+
+    
+
+    
+
     
 
     
@@ -1667,7 +1814,7 @@
     
     <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#line4099">line 4099</a>
+        <a href="ProtoBuf.js.html">ProtoBuf.js</a>, <a href="ProtoBuf.js.html#line4303">line 4303</a>
     </li></ul></dd>
     
 
@@ -1723,8 +1870,10 @@
         
             
 <dt>
-    <h4 class="name" id="loadProto"><span class="type-signature">(static) </span>loadProto<span class="signature">(proto, builder<span class="signature-attributes">opt</span>, filename<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a>}</span></h4>
+    
+        <h4 class="name" id="loadProto"><span class="type-signature">(static) </span>loadProto<span class="signature">(proto, builder<span class="signature-attributes">opt</span>, filename<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a>}</span></h4>
 
+        
     
 </dt>
 <dd>
@@ -1740,6 +1889,8 @@
     
 
     
+
+    
         <h5>Parameters:</h5>
         
 
@@ -1875,7 +2026,14 @@
     
 
     
+
+
 <dl class="details">
+
+    
+
+    
+
     
 
     
@@ -1897,7 +2055,7 @@
     
     <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#line3979">line 3979</a>
+        <a href="ProtoBuf.js.html">ProtoBuf.js</a>, <a href="ProtoBuf.js.html#line4185">line 4185</a>
     </li></ul></dd>
     
 
@@ -1976,8 +2134,10 @@
         
             
 <dt>
-    <h4 class="name" id="loadProtoFile"><span class="type-signature">(static) </span>loadProtoFile<span class="signature">(filename, callback<span class="signature-attributes">opt</span>, builder<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a>|undefined}</span></h4>
+    
+        <h4 class="name" id="loadProtoFile"><span class="type-signature">(static) </span>loadProtoFile<span class="signature">(filename, callback<span class="signature-attributes">opt</span>, builder<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a>|undefined}</span></h4>
 
+        
     
 </dt>
 <dd>
@@ -1993,6 +2153,8 @@
     
 
     
+
+    
         <h5>Parameters:</h5>
         
 
@@ -2125,7 +2287,14 @@
     
 
     
+
+
 <dl class="details">
+
+    
+
+    
+
     
 
     
@@ -2147,7 +2316,7 @@
     
     <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#line4011">line 4011</a>
+        <a href="ProtoBuf.js.html">ProtoBuf.js</a>, <a href="ProtoBuf.js.html#line4216">line 4216</a>
     </li></ul></dd>
     
 
@@ -2203,15 +2372,17 @@
         
             
 <dt>
-    <h4 class="name" id="newBuilder"><span class="type-signature">(static) </span>newBuilder<span class="signature">(pkg<span class="signature-attributes">opt</span>, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a>}</span></h4>
+    
+        <h4 class="name" id="newBuilder"><span class="type-signature">(static) </span>newBuilder<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; (non-null) {<a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a>}</span></h4>
 
+        
     
 </dt>
 <dd>
 
     
     <div class="description">
-        <p>Constructs a new Builder with the specified package defined.</p>
+        <p>Constructs a new empty Builder.</p>
     </div>
     
 
@@ -2220,6 +2391,8 @@
     
 
     
+
+    
         <h5>Parameters:</h5>
         
 
@@ -2245,40 +2418,6 @@
     <tbody>
     
 
-        <tr>
-            
-                <td class="name"><code>pkg</code></td>
-            
-
-            <td class="type">
-            
-                
-<span class="param-type">string</span>
-
-
-            
-            </td>
-
-            
-                <td class="attributes">
-                
-                    &lt;optional><br>
-                
-
-                
-
-                
-                </td>
-            
-
-            
-
-            <td class="description last"><p>Package name as fully qualified name, e.g. &quot;My.Game&quot;. If no package is specified, the
-builder will only contain a global namespace.</p></td>
-        </tr>
-
-    
-
         <tr>
             
                 <td class="name"><code>options</code></td>
@@ -2307,7 +2446,7 @@ builder will only contain a global namespace.</p></td>
 
             
 
-            <td class="description last"><p>Top level options</p></td>
+            <td class="description last"><p>Builder options, defaults to global options set on ProtoBuf</p></td>
         </tr>
 
     
@@ -2316,7 +2455,14 @@ builder will only contain a global namespace.</p></td>
     
 
     
+
+
 <dl class="details">
+
+    
+
+    
+
     
 
     
@@ -2338,7 +2484,7 @@ builder will only contain a global namespace.</p></td>
     
     <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#line4057">line 4057</a>
+        <a href="ProtoBuf.js.html">ProtoBuf.js</a>, <a href="ProtoBuf.js.html#line4260">line 4260</a>
     </li></ul></dd>
     
 
@@ -2365,7 +2511,7 @@ builder will only contain a global namespace.</p></td>
     
             
 <div class="param-desc">
-    <p>New Builder</p>
+    <p>Builder</p>
 </div>
 
 
@@ -2390,8 +2536,10 @@ builder will only contain a global namespace.</p></td>
         
             
 <dt>
-    <h4 class="name" id="protoFromFile"><span class="type-signature">(static) </span>protoFromFile<span class="signature">(filename, callback<span class="signature-attributes">opt</span>, builder<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a>|undefined}</span></h4>
+    
+        <h4 class="name" id="protoFromFile"><span class="type-signature">(static) </span>protoFromFile<span class="signature">(filename, callback<span class="signature-attributes">opt</span>, builder<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a>|undefined}</span></h4>
 
+        
     
 </dt>
 <dd>
@@ -2407,6 +2555,8 @@ builder will only contain a global namespace.</p></td>
     
 
     
+
+    
         <h5>Parameters:</h5>
         
 
@@ -2539,7 +2689,14 @@ builder will only contain a global namespace.</p></td>
     
 
     
+
+
 <dl class="details">
+
+    
+
+    
+
     
 
     
@@ -2561,7 +2718,7 @@ builder will only contain a global namespace.</p></td>
     
     <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#line4046">line 4046</a>
+        <a href="ProtoBuf.js.html">ProtoBuf.js</a>, <a href="ProtoBuf.js.html#line4251">line 4251</a>
     </li></ul></dd>
     
 
@@ -2617,8 +2774,10 @@ builder will only contain a global namespace.</p></td>
         
             
 <dt>
-    <h4 class="name" id="protoFromString"><span class="type-signature">(static) </span>protoFromString<span class="signature">(proto, builder<span class="signature-attributes">opt</span>, filename<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a>}</span></h4>
+    
+        <h4 class="name" id="protoFromString"><span class="type-signature">(static) </span>protoFromString<span class="signature">(proto, builder<span class="signature-attributes">opt</span>, filename<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a>}</span></h4>
 
+        
     
 </dt>
 <dd>
@@ -2634,6 +2793,8 @@ builder will only contain a global namespace.</p></td>
     
 
     
+
+    
         <h5>Parameters:</h5>
         
 
@@ -2766,7 +2927,14 @@ builder will only contain a global namespace.</p></td>
     
 
     
+
+
 <dl class="details">
+
+    
+
+    
+
     
 
     
@@ -2788,7 +2956,7 @@ builder will only contain a global namespace.</p></td>
     
     <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#line3997">line 3997</a>
+        <a href="ProtoBuf.js.html">ProtoBuf.js</a>, <a href="ProtoBuf.js.html#line4202">line 4202</a>
     </li></ul></dd>
     
 
@@ -2880,13 +3048,13 @@ builder will only contain a global namespace.</p></td>
 </div>
 
 <nav>
-    <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.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.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>
+    <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.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 clear="both">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Tue Aug 26 2014 22:15:41 GMT+0200 (Mitteleuropäische Sommerzeit)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha10</a> on Mon Nov 24 2014 18:08:27 GMT+0100 (Mitteleuropäische Zeit)
 </footer>
 
 <script> prettyPrint(); </script>