Skip to content

Commit 3e89ad4

Browse files
calebsandercalebsander
committed
Update RecursiveType doc and rerun typedoc
1 parent 3906ce7 commit 3e89ad4

File tree

111 files changed

+1211
-1393
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

111 files changed

+1211
-1393
lines changed

‎docs/assets/js/search.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/classes/_lib_appendable_.appendablebuffer.html‎

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -77,16 +77,15 @@ <h1>Class AppendableBuffer</h1>
7777
Implemented by <a href="_lib_growable_buffer_.growablebuffer.html">GrowableBuffer</a>, as well as
7878
<a href="_lib_appendable_stream_.appendablestream.html">AppendableStream</a> (a wrapper around a writable stream).
7979
All methods can be chained, e.g.</p>
80-
<pre><code class="lang-javascript"><span class="hljs-keyword">let</span> gb = <span class="hljs-keyword">new</span> GrowableBuffer
80+
<pre><code class="language-javascript"><span class="hljs-keyword">let</span> gb = <span class="hljs-keyword">new</span> GrowableBuffer
8181
gb
8282
.add(<span class="hljs-number">1</span>).add(<span class="hljs-number">2</span>)
8383
.addAll(<span class="hljs-keyword">new</span> <span class="hljs-built_in">Uint8Array</span>([<span class="hljs-number">3</span>, <span class="hljs-number">4</span>, <span class="hljs-number">5</span>]).buffer)
8484
.pause()
8585
.add(<span class="hljs-number">0</span>)
8686
.reset()
8787
.resume()
88-
<span class="hljs-built_in">console</span>.log(<span class="hljs-keyword">new</span> <span class="hljs-built_in">Uint8Array</span>(gb.toBuffer())) <span class="hljs-comment">//Uint8Array [ 1, 2, 3, 4, 5 ]</span>
89-
</code></pre>
88+
<span class="hljs-built_in">console</span>.log(<span class="hljs-keyword">new</span> <span class="hljs-built_in">Uint8Array</span>(gb.toBuffer())) <span class="hljs-comment">//Uint8Array [ 1, 2, 3, 4, 5 ]</span></code></pre>
9089
</div>
9190
</div>
9291
</section>
@@ -137,7 +136,7 @@ <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> length</h3>
137136
<div class="tsd-signature tsd-kind-icon">length<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
138137
<aside class="tsd-sources">
139138
<ul>
140-
<li>Defined in <a href="https://github.com/calebsander/structure-bytes/blob/dbfc9c3/lib/appendable.ts#L23">lib/appendable.ts:23</a></li>
139+
<li>Defined in lib/appendable.ts:23</li>
141140
</ul>
142141
</aside>
143142
<div class="tsd-comment tsd-typography">
@@ -159,7 +158,7 @@ <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> add</h3>
159158
<li class="tsd-description">
160159
<aside class="tsd-sources">
161160
<ul>
162-
<li>Defined in <a href="https://github.com/calebsander/structure-bytes/blob/dbfc9c3/lib/appendable.ts#L29">lib/appendable.ts:29</a></li>
161+
<li>Defined in lib/appendable.ts:29</li>
163162
</ul>
164163
</aside>
165164
<div class="tsd-comment tsd-typography">
@@ -191,7 +190,7 @@ <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> add<wbr>All</h3>
191190
<li class="tsd-description">
192191
<aside class="tsd-sources">
193192
<ul>
194-
<li>Defined in <a href="https://github.com/calebsander/structure-bytes/blob/dbfc9c3/lib/appendable.ts#L37">lib/appendable.ts:37</a></li>
193+
<li>Defined in lib/appendable.ts:37</li>
195194
</ul>
196195
</aside>
197196
<div class="tsd-comment tsd-typography">
@@ -225,7 +224,7 @@ <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> pause</h3>
225224
<li class="tsd-description">
226225
<aside class="tsd-sources">
227226
<ul>
228-
<li>Defined in <a href="https://github.com/calebsander/structure-bytes/blob/dbfc9c3/lib/appendable.ts#L62">lib/appendable.ts:62</a></li>
227+
<li>Defined in lib/appendable.ts:62</li>
229228
</ul>
230229
</aside>
231230
<div class="tsd-comment tsd-typography">
@@ -240,7 +239,7 @@ <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> pause</h3>
240239
<p>If called multiple times, <a href="_lib_appendable_.appendablebuffer.html#resume">resume</a>
241240
and <a href="_lib_appendable_.appendablebuffer.html#reset">reset</a> only act on bytes added
242241
since the most recent pause. Example:</p>
243-
<pre><code class="lang-javascript"><span class="hljs-keyword">let</span> gb = <span class="hljs-keyword">new</span> GrowableBuffer
242+
<pre><code class="language-javascript"><span class="hljs-keyword">let</span> gb = <span class="hljs-keyword">new</span> GrowableBuffer
244243
gb
245244
.pause()
246245
.add(<span class="hljs-number">1</span>).add(<span class="hljs-number">2</span>).add(<span class="hljs-number">3</span>)
@@ -249,8 +248,7 @@ <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> pause</h3>
249248
.reset() <span class="hljs-comment">//cancels [4, 5, 6]</span>
250249
.resume() <span class="hljs-comment">//resumes []</span>
251250
.resume() <span class="hljs-comment">//resumes [1, 2, 3]</span>
252-
<span class="hljs-built_in">console</span>.log(<span class="hljs-keyword">new</span> <span class="hljs-built_in">Uint8Array</span>(gb.toBuffer())) <span class="hljs-comment">//Uint8Array [ 1, 2, 3 ]</span>
253-
</code></pre>
251+
<span class="hljs-built_in">console</span>.log(<span class="hljs-keyword">new</span> <span class="hljs-built_in">Uint8Array</span>(gb.toBuffer())) <span class="hljs-comment">//Uint8Array [ 1, 2, 3 ]</span></code></pre>
254252
</div>
255253
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
256254
</li>
@@ -266,7 +264,7 @@ <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> reset</h3>
266264
<li class="tsd-description">
267265
<aside class="tsd-sources">
268266
<ul>
269-
<li>Defined in <a href="https://github.com/calebsander/structure-bytes/blob/dbfc9c3/lib/appendable.ts#L78">lib/appendable.ts:78</a></li>
267+
<li>Defined in lib/appendable.ts:78</li>
270268
</ul>
271269
</aside>
272270
<div class="tsd-comment tsd-typography">
@@ -297,7 +295,7 @@ <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> resume</h3>
297295
<li class="tsd-description">
298296
<aside class="tsd-sources">
299297
<ul>
300-
<li>Defined in <a href="https://github.com/calebsander/structure-bytes/blob/dbfc9c3/lib/appendable.ts#L69">lib/appendable.ts:69</a></li>
298+
<li>Defined in lib/appendable.ts:69</li>
301299
</ul>
302300
</aside>
303301
<div class="tsd-comment tsd-typography">

‎docs/classes/_lib_appendable_stream_.appendablestream.html‎

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ <h3>constructor</h3>
144144
<li class="tsd-description">
145145
<aside class="tsd-sources">
146146
<ul>
147-
<li>Defined in <a href="https://github.com/calebsander/structure-bytes/blob/dbfc9c3/lib/appendable-stream.ts#L20">lib/appendable-stream.ts:20</a></li>
147+
<li>Defined in lib/appendable-stream.ts:20</li>
148148
</ul>
149149
</aside>
150150
<div class="tsd-comment tsd-typography">
@@ -173,7 +173,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> out<wbr>Stream</h3>
173173
<div class="tsd-signature tsd-kind-icon">out<wbr>Stream<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Writable</span></div>
174174
<aside class="tsd-sources">
175175
<ul>
176-
<li>Defined in <a href="https://github.com/calebsander/structure-bytes/blob/dbfc9c3/lib/appendable-stream.ts#L17">lib/appendable-stream.ts:17</a></li>
176+
<li>Defined in lib/appendable-stream.ts:17</li>
177177
</ul>
178178
</aside>
179179
</section>
@@ -183,7 +183,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> pause<wbr>Count</h3>
183183
<div class="tsd-signature tsd-kind-icon">pause<wbr>Count<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
184184
<aside class="tsd-sources">
185185
<ul>
186-
<li>Defined in <a href="https://github.com/calebsander/structure-bytes/blob/dbfc9c3/lib/appendable-stream.ts#L19">lib/appendable-stream.ts:19</a></li>
186+
<li>Defined in lib/appendable-stream.ts:19</li>
187187
</ul>
188188
</aside>
189189
</section>
@@ -193,7 +193,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> paused</h3>
193193
<div class="tsd-signature tsd-kind-icon">paused<span class="tsd-signature-symbol">:</span> <a href="_lib_growable_buffer_.growablebuffer.html" class="tsd-signature-type">GrowableBuffer</a></div>
194194
<aside class="tsd-sources">
195195
<ul>
196-
<li>Defined in <a href="https://github.com/calebsander/structure-bytes/blob/dbfc9c3/lib/appendable-stream.ts#L20">lib/appendable-stream.ts:20</a></li>
196+
<li>Defined in lib/appendable-stream.ts:20</li>
197197
</ul>
198198
</aside>
199199
</section>
@@ -203,7 +203,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> written<wbr>Bytes</h3>
203203
<div class="tsd-signature tsd-kind-icon">written<wbr>Bytes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
204204
<aside class="tsd-sources">
205205
<ul>
206-
<li>Defined in <a href="https://github.com/calebsander/structure-bytes/blob/dbfc9c3/lib/appendable-stream.ts#L18">lib/appendable-stream.ts:18</a></li>
206+
<li>Defined in lib/appendable-stream.ts:18</li>
207207
</ul>
208208
</aside>
209209
</section>
@@ -221,7 +221,7 @@ <h3>length</h3>
221221
<aside class="tsd-sources">
222222
<p>Overrides <a href="_lib_appendable_.appendablebuffer.html">AppendableBuffer</a>.<a href="_lib_appendable_.appendablebuffer.html#length">length</a></p>
223223
<ul>
224-
<li>Defined in <a href="https://github.com/calebsander/structure-bytes/blob/dbfc9c3/lib/appendable-stream.ts#L65">lib/appendable-stream.ts:65</a></li>
224+
<li>Defined in lib/appendable-stream.ts:65</li>
225225
</ul>
226226
</aside>
227227
<div class="tsd-comment tsd-typography">
@@ -247,7 +247,7 @@ <h3>add</h3>
247247
<aside class="tsd-sources">
248248
<p>Overrides <a href="_lib_appendable_.appendablebuffer.html">AppendableBuffer</a>.<a href="_lib_appendable_.appendablebuffer.html#add">add</a></p>
249249
<ul>
250-
<li>Defined in <a href="https://github.com/calebsander/structure-bytes/blob/dbfc9c3/lib/appendable-stream.ts#L39">lib/appendable-stream.ts:39</a></li>
250+
<li>Defined in lib/appendable-stream.ts:39</li>
251251
</ul>
252252
</aside>
253253
<div class="tsd-comment tsd-typography">
@@ -280,7 +280,7 @@ <h3>add<wbr>All</h3>
280280
<aside class="tsd-sources">
281281
<p>Overrides <a href="_lib_appendable_.appendablebuffer.html">AppendableBuffer</a>.<a href="_lib_appendable_.appendablebuffer.html#addall">addAll</a></p>
282282
<ul>
283-
<li>Defined in <a href="https://github.com/calebsander/structure-bytes/blob/dbfc9c3/lib/appendable-stream.ts#L49">lib/appendable-stream.ts:49</a></li>
283+
<li>Defined in lib/appendable-stream.ts:49</li>
284284
</ul>
285285
</aside>
286286
<div class="tsd-comment tsd-typography">
@@ -312,7 +312,7 @@ <h3>end</h3>
312312
<li class="tsd-description">
313313
<aside class="tsd-sources">
314314
<ul>
315-
<li>Defined in <a href="https://github.com/calebsander/structure-bytes/blob/dbfc9c3/lib/appendable-stream.ts#L59">lib/appendable-stream.ts:59</a></li>
315+
<li>Defined in lib/appendable-stream.ts:59</li>
316316
</ul>
317317
</aside>
318318
<div class="tsd-comment tsd-typography">
@@ -335,7 +335,7 @@ <h3>pause</h3>
335335
<aside class="tsd-sources">
336336
<p>Overrides <a href="_lib_appendable_.appendablebuffer.html">AppendableBuffer</a>.<a href="_lib_appendable_.appendablebuffer.html#pause">pause</a></p>
337337
<ul>
338-
<li>Defined in <a href="https://github.com/calebsander/structure-bytes/blob/dbfc9c3/lib/appendable-stream.ts#L92">lib/appendable-stream.ts:92</a></li>
338+
<li>Defined in lib/appendable-stream.ts:92</li>
339339
</ul>
340340
</aside>
341341
<div class="tsd-comment tsd-typography">
@@ -350,7 +350,7 @@ <h3>pause</h3>
350350
<p>If called multiple times, <a href="_lib_appendable_stream_.appendablestream.html#resume">resume</a>
351351
and <a href="_lib_appendable_stream_.appendablestream.html#reset">reset</a> only act on bytes added
352352
since the most recent pause. Example:</p>
353-
<pre><code class="lang-javascript"><span class="hljs-keyword">let</span> gb = <span class="hljs-keyword">new</span> GrowableBuffer
353+
<pre><code class="language-javascript"><span class="hljs-keyword">let</span> gb = <span class="hljs-keyword">new</span> GrowableBuffer
354354
gb
355355
.pause()
356356
.add(<span class="hljs-number">1</span>).add(<span class="hljs-number">2</span>).add(<span class="hljs-number">3</span>)
@@ -359,8 +359,7 @@ <h3>pause</h3>
359359
.reset() <span class="hljs-comment">//cancels [4, 5, 6]</span>
360360
.resume()
361361
.resume() <span class="hljs-comment">//resumes [1, 2, 3]</span>
362-
<span class="hljs-built_in">console</span>.log(<span class="hljs-keyword">new</span> <span class="hljs-built_in">Uint8Array</span>(gb.toBuffer())) <span class="hljs-comment">//Uint8Array [ 1, 2, 3 ]</span>
363-
</code></pre>
362+
<span class="hljs-built_in">console</span>.log(<span class="hljs-keyword">new</span> <span class="hljs-built_in">Uint8Array</span>(gb.toBuffer())) <span class="hljs-comment">//Uint8Array [ 1, 2, 3 ]</span></code></pre>
364363
</div>
365364
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
366365
</li>
@@ -377,7 +376,7 @@ <h3>reset</h3>
377376
<aside class="tsd-sources">
378377
<p>Overrides <a href="_lib_appendable_.appendablebuffer.html">AppendableBuffer</a>.<a href="_lib_appendable_.appendablebuffer.html#reset">reset</a></p>
379378
<ul>
380-
<li>Defined in <a href="https://github.com/calebsander/structure-bytes/blob/dbfc9c3/lib/appendable-stream.ts#L121">lib/appendable-stream.ts:121</a></li>
379+
<li>Defined in lib/appendable-stream.ts:121</li>
381380
</ul>
382381
</aside>
383382
<div class="tsd-comment tsd-typography">
@@ -409,7 +408,7 @@ <h3>resume</h3>
409408
<aside class="tsd-sources">
410409
<p>Overrides <a href="_lib_appendable_.appendablebuffer.html">AppendableBuffer</a>.<a href="_lib_appendable_.appendablebuffer.html#resume">resume</a></p>
411410
<ul>
412-
<li>Defined in <a href="https://github.com/calebsander/structure-bytes/blob/dbfc9c3/lib/appendable-stream.ts#L103">lib/appendable-stream.ts:103</a></li>
411+
<li>Defined in lib/appendable-stream.ts:103</li>
413412
</ul>
414413
</aside>
415414
<div class="tsd-comment tsd-typography">

0 commit comments

Comments
 (0)