Added RecursiveType to README; note on valid types

Author: calebsander

README.md

@@ -55,6 +55,7 @@ A lot of data, especially data designed to be used in many different languages,
 	- `Map<KeyType, ValueType>` (a mapping of `KeyType` instances to `ValueType` instances)
 	- `Enum<Type>` (a fixed set of up to 255 `Type`s; useful when only a small subset of `Type` instances represent possible values, especially with `String`s)
 	- `Choice` (a fixed set of up to 255 types that values can take on)
+	- `Recursive<Type>` (a type that can reference itself and be used to serialize circular data structures)
 	- `Optional<Type>` (either `null` or an instance of `Type`)
 	- `Pointer<Type>` (allows multiple long instances of `Type` with the same bytes to be stored only once)
 

docs/global.html

@@ -379,7 +379,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="recursive-registry.js.html">recursive-registry.js</a>, <a href="recursive-registry.js.html#line31">line 31</a>
+        <a href="recursive-registry.js.html">recursive-registry.js</a>, <a href="recursive-registry.js.html#line36">line 36</a>
     </li></ul></dd>
 
 
@@ -859,7 +859,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="recursive-registry.js.html">recursive-registry.js</a>, <a href="recursive-registry.js.html#line45">line 45</a>
+        <a href="recursive-registry.js.html">recursive-registry.js</a>, <a href="recursive-registry.js.html#line50">line 50</a>
     </li></ul></dd>
 
 
@@ -1471,7 +1471,12 @@ <h4 class="name" id="registerType"><span class="type-signature"></span>registerT
 
 <div class="description">
     Registers a type under a name so
-the name can be used in a <a href="RecursiveType.html"><code>RecursiveType</code></a>
+the name can be used in a <a href="RecursiveType.html"><code>RecursiveType</code></a>.
+The type must be either an <a href="ArrayType.html"><code>ArrayType</code></a>,
+<a href="MapType.html"><code>MapType</code></a>, <a href="SetType.html"><code>SetType</code></a>, <a href="StructType.html"><code>StructType</code></a>,
+or <a href="TupleType.html"><code>TupleType</code></a> due to implementation limitations.
+If you need to use a different type, wrap it
+in a single-field <a href="StructType.html"><code>StructType</code></a>.
 </div>
 
 

docs/index.html

@@ -98,6 +98,7 @@ <h2>Data types</h2><ul>
 <li><code>Map&lt;KeyType, ValueType&gt;</code> (a mapping of <code>KeyType</code> instances to <code>ValueType</code> instances)</li>
 <li><code>Enum&lt;Type&gt;</code> (a fixed set of up to 255 <code>Type</code>s; useful when only a small subset of <code>Type</code> instances represent possible values, especially with <code>String</code>s)</li>
 <li><code>Choice</code> (a fixed set of up to 255 types that values can take on)</li>
+<li><code>Recursive&lt;Type&gt;</code> (a type that can reference itself and be used to serialize circular data structures)</li>
 <li><code>Optional&lt;Type&gt;</code> (either <code>null</code> or an instance of <code>Type</code>)</li>
 <li><code>Pointer&lt;Type&gt;</code> (allows multiple long instances of <code>Type</code> with the same bytes to be stored only once)</li>
 </ul>

docs/recursive-registry.js.html

@@ -38,7 +38,12 @@ <h1 class="page-title">Source: recursive-registry.js</h1>
 	/** @function
 	 * @name registerType
 	 * @desc Registers a type under a name so
-	 * the name can be used in a {@link RecursiveType}
+	 * the name can be used in a {@link RecursiveType}.
+	 * The type must be either an {@link ArrayType},
+	 * {@link MapType}, {@link SetType}, {@link StructType},
+	 * or {@link TupleType} due to implementation limitations.
+	 * If you need to use a different type, wrap it
+	 * in a single-field {@link StructType}.
 	 * @throws {Error} If a type is already registered under the name
 	 * @param {{type, name}} params
 	 * @param {Type} params.type The type to register

recursive-registry.js

@@ -10,7 +10,12 @@ module.exports = {
 	/** @function
 	 * @name registerType
 	 * @desc Registers a type under a name so
-	 * the name can be used in a {@link RecursiveType}
+	 * the name can be used in a {@link RecursiveType}.
+	 * The type must be either an {@link ArrayType},
+	 * {@link MapType}, {@link SetType}, {@link StructType},
+	 * or {@link TupleType} due to implementation limitations.
+	 * If you need to use a different type, wrap it
+	 * in a single-field {@link StructType}.
 	 * @throws {Error} If a type is already registered under the name
 	 * @param {{type, name}} params
 	 * @param {Type} params.type The type to register