Add extra details to ReadableStream description

nkronlage · nkronlage · commit 35ffda88a7f4 · 2022-08-07T19:20:23.000-07:00
diff --git a/content/Streams/readablestream.jsdoc b/content/Streams/readablestream.jsdoc
@@ -1,6 +1,8 @@
 ReadableStream : Object
 
-Represents a readable stream of data.
+Represents a readable stream of data. The stream can be read using the
+%%#getReader|ReadableStreamReader%% or by %%#pipeTo|piping to%% a
+%%/WritableStream|WritableStream%%.
 
 Spec:
 https://streams.spec.whatwg.org/#rs-class-definition
diff --git a/docs/ReadableStream.html b/docs/ReadableStream.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html><html><head><meta charset="utf-8"><title>ReadableStream JavaScript API</title><meta name="description" content="Interactive API reference for the JavaScript ReadableStream Object. Represents a readable stream of data."><link rel="stylesheet" type="text/css" href="styles.css"><script type="text/javascript">var _gaq = _gaq || [];
+<!DOCTYPE html><html><head><meta charset="utf-8"><title>ReadableStream JavaScript API</title><meta name="description" content="Interactive API reference for the JavaScript ReadableStream Object. Represents a readable stream of data. The stream can be read using the  ReadableStreamReader or by piping to a WritableStream."><link rel="stylesheet" type="text/css" href="styles.css"><script type="text/javascript">var _gaq = _gaq || [];
   _gaq.push(['_setAccount', 'UA-23450559-1']);
   _gaq.push(['_trackPageview']);
   (function() {
@@ -10,7 +10,7 @@
 }
 if (localStorage.theme) {
   document.body.parentElement.classList.add(localStorage.theme);
-}</script><div class="topnav"><a href="/">JavaScripture</a><div class="bookmarks"><a class="bookmark contribute" href="https://github.com/nkronlage/JavaScripture">Contribute via GitHub</a> <a class="bookmark" href="/feedback">Feedback</a></div></div><div class="container"><nav class="leftnav"><div id="searchContainer"><input id="searchBox" type="text" placeholder="Search (Ctrl + S)" autocomplete="false"><div id="resultsBox" style="display:none;"></div></div><div id="apichooser"><a href="#" onclick="openApiChooser(); return false;"><div class="arrow"></div><span id="selectedsets"></span></a><div id="obscure"></div><div id="apisets"><ul></ul></div></div><div class="toc"><h2>ReadableStream</h2><div class="navgroup"><div class="group"><a href="#Constructors">Constructors</a></div><div class="group collapsed"><a href="#InstanceProperties" onclick="expandoClicked(this.parentNode); return false;"><div class="arrow"></div>Instance Properties</a><div class="subgroup"><a href="#locked">locked</a></div></div><div class="group collapsed"><a href="#InstanceMethods" onclick="expandoClicked(this.parentNode); return false;"><div class="arrow"></div>Instance Methods</a><div class="subgroup"><a href="#cancel_Object">cancel</a><a href="#getReader_Object">getReader</a><a href="#pipeThrough_Object_Object">pipeThrough</a><a href="#pipeTo_WritableStream_Object">pipeTo</a><a href="#tee_">tee</a></div></div></div><h2>Streams API</h2><div id="related-apis" class="navgroup"></div><h2>All API</h2><div id="rootObjs" class="navgroup"><span class="empty">No API set selected.</span></div></div></nav><div class="content"><h1 class="declaration"><span class="object">ReadableStream</span> <span class="type">: <a href="/Object">Object</a></span></h1><div class="metadata"><span>constructor</span></div><div class="objectdescription">Represents a readable stream of data.<div class="membermetadata"><a href="https://streams.spec.whatwg.org/#rs-class-definition" class="spec">Spec</a></div></div><div><a name="Constructors"></a><h2>Constructors</h2><div class="member"><div class="expand-members" title="Toggle showing all descriptions and examples"></div><a name="ReadableStream"></a> <a name="new_ReadableStream_ReadableStreamSource_QueuingStrategy"></a><div class="declaration">new <span class="membername primary">ReadableStream</span>(<span class="membername">source</span>&nbsp;:&nbsp;<a class="membertype" href="/ReadableStreamSource">ReadableStreamSource</a>, <span class="optional">[<span class="membername">strategy</span>&nbsp;:&nbsp;<a class="membertype" href="/QueuingStrategy">QueuingStrategy</a>]</span>)&nbsp;:&nbsp;<a class="membertype" href="/ReadableStream">ReadableStream</a></div><div class="member-body"><p class="description"></p><div class="membermetadata"><a href="https://streams.spec.whatwg.org/#rs-constructor" class="spec">Spec</a></div></div></div></div><div><a name="InstanceProperties"></a><h2>Instance Properties</h2><div class="member"><div class="expand-members" title="Toggle showing all descriptions and examples"></div><a name="locked"></a><div class="declaration"><span class="membername primary">locked</span>&nbsp;:&nbsp;<a class="membertype" href="/Boolean">Boolean</a>&nbsp;&nbsp;<span class="metadata">readonly</span></div><div class="member-body"><p class="description"></p><div class="membermetadata"><a href="https://streams.spec.whatwg.org/#rs-locked" class="spec">Spec</a></div></div></div></div><div><a name="InstanceMethods"></a><h2>Instance Methods</h2><div class="member"><div class="expand-members" title="Toggle showing all descriptions and examples"></div><a name="cancel"></a> <a name="cancel_Object"></a><div class="declaration"><span class="membername primary">cancel</span>(<span class="optional">[<span class="membername">reason</span>&nbsp;:&nbsp;<a class="membertype" href="/Object">Object</a>]</span>)&nbsp;:&nbsp;<a class="membertype" href="/Promise">Promise</a>&lt;<a class="membertype" href="/undefined">undefined</a>&gt;</div><div class="member-body"><p class="description"></p><div class="membermetadata"><a href="https://streams.spec.whatwg.org/#rs-cancel" class="spec">Spec</a></div></div></div><div class="member"><div class="expand-members" title="Toggle showing all descriptions and examples"></div><a name="getReader"></a> <a name="getReader_Object"></a><div class="declaration"><span class="membername primary">getReader</span>(<span class="optional">[<span class="membername">options</span>&nbsp;:&nbsp;<a class="membertype" href="/Object">Object</a>]</span>)&nbsp;:&nbsp;<a class="membertype" href="/ReadableStreamDefaultReader">ReadableStreamDefaultReader</a><div class="subfunction"><span class="membername">options</span>&nbsp;:&nbsp;{<table><tr><td><span class="membername">mode</span>&nbsp;:</td><td><a class="membertype" href="/String">String</a></td><td>Either <code>undefined</code> or <code>'byob'</code></td></tr></table><span class="subfunctionclose">}</span></div></div><div class="member-body"><p class="description"></p><div class="example"><div class="codePanel"><h4>Example:</h4><textarea class="code" rows="12" cols="60" wrap="off">
+}</script><div class="topnav"><a href="/">JavaScripture</a><div class="bookmarks"><a class="bookmark contribute" href="https://github.com/nkronlage/JavaScripture">Contribute via GitHub</a> <a class="bookmark" href="/feedback">Feedback</a></div></div><div class="container"><nav class="leftnav"><div id="searchContainer"><input id="searchBox" type="text" placeholder="Search (Ctrl + S)" autocomplete="false"><div id="resultsBox" style="display:none;"></div></div><div id="apichooser"><a href="#" onclick="openApiChooser(); return false;"><div class="arrow"></div><span id="selectedsets"></span></a><div id="obscure"></div><div id="apisets"><ul></ul></div></div><div class="toc"><h2>ReadableStream</h2><div class="navgroup"><div class="group"><a href="#Constructors">Constructors</a></div><div class="group collapsed"><a href="#InstanceProperties" onclick="expandoClicked(this.parentNode); return false;"><div class="arrow"></div>Instance Properties</a><div class="subgroup"><a href="#locked">locked</a></div></div><div class="group collapsed"><a href="#InstanceMethods" onclick="expandoClicked(this.parentNode); return false;"><div class="arrow"></div>Instance Methods</a><div class="subgroup"><a href="#cancel_Object">cancel</a><a href="#getReader_Object">getReader</a><a href="#pipeThrough_Object_Object">pipeThrough</a><a href="#pipeTo_WritableStream_Object">pipeTo</a><a href="#tee_">tee</a></div></div></div><h2>Streams API</h2><div id="related-apis" class="navgroup"></div><h2>All API</h2><div id="rootObjs" class="navgroup"><span class="empty">No API set selected.</span></div></div></nav><div class="content"><h1 class="declaration"><span class="object">ReadableStream</span> <span class="type">: <a href="/Object">Object</a></span></h1><div class="metadata"><span>constructor</span></div><div class="objectdescription">Represents a readable stream of data. The stream can be read using the <a href="#getReader">ReadableStreamReader</a> or by <a href="#pipeTo">piping to</a> a <a href="/WritableStream">WritableStream</a>.<div class="membermetadata"><a href="https://streams.spec.whatwg.org/#rs-class-definition" class="spec">Spec</a></div></div><div><a name="Constructors"></a><h2>Constructors</h2><div class="member"><div class="expand-members" title="Toggle showing all descriptions and examples"></div><a name="ReadableStream"></a> <a name="new_ReadableStream_ReadableStreamSource_QueuingStrategy"></a><div class="declaration">new <span class="membername primary">ReadableStream</span>(<span class="membername">source</span>&nbsp;:&nbsp;<a class="membertype" href="/ReadableStreamSource">ReadableStreamSource</a>, <span class="optional">[<span class="membername">strategy</span>&nbsp;:&nbsp;<a class="membertype" href="/QueuingStrategy">QueuingStrategy</a>]</span>)&nbsp;:&nbsp;<a class="membertype" href="/ReadableStream">ReadableStream</a></div><div class="member-body"><p class="description"></p><div class="membermetadata"><a href="https://streams.spec.whatwg.org/#rs-constructor" class="spec">Spec</a></div></div></div></div><div><a name="InstanceProperties"></a><h2>Instance Properties</h2><div class="member"><div class="expand-members" title="Toggle showing all descriptions and examples"></div><a name="locked"></a><div class="declaration"><span class="membername primary">locked</span>&nbsp;:&nbsp;<a class="membertype" href="/Boolean">Boolean</a>&nbsp;&nbsp;<span class="metadata">readonly</span></div><div class="member-body"><p class="description"></p><div class="membermetadata"><a href="https://streams.spec.whatwg.org/#rs-locked" class="spec">Spec</a></div></div></div></div><div><a name="InstanceMethods"></a><h2>Instance Methods</h2><div class="member"><div class="expand-members" title="Toggle showing all descriptions and examples"></div><a name="cancel"></a> <a name="cancel_Object"></a><div class="declaration"><span class="membername primary">cancel</span>(<span class="optional">[<span class="membername">reason</span>&nbsp;:&nbsp;<a class="membertype" href="/Object">Object</a>]</span>)&nbsp;:&nbsp;<a class="membertype" href="/Promise">Promise</a>&lt;<a class="membertype" href="/undefined">undefined</a>&gt;</div><div class="member-body"><p class="description"></p><div class="membermetadata"><a href="https://streams.spec.whatwg.org/#rs-cancel" class="spec">Spec</a></div></div></div><div class="member"><div class="expand-members" title="Toggle showing all descriptions and examples"></div><a name="getReader"></a> <a name="getReader_Object"></a><div class="declaration"><span class="membername primary">getReader</span>(<span class="optional">[<span class="membername">options</span>&nbsp;:&nbsp;<a class="membertype" href="/Object">Object</a>]</span>)&nbsp;:&nbsp;<a class="membertype" href="/ReadableStreamDefaultReader">ReadableStreamDefaultReader</a><div class="subfunction"><span class="membername">options</span>&nbsp;:&nbsp;{<table><tr><td><span class="membername">mode</span>&nbsp;:</td><td><a class="membertype" href="/String">String</a></td><td>Either <code>undefined</code> or <code>'byob'</code></td></tr></table><span class="subfunctionclose">}</span></div></div><div class="member-body"><p class="description"></p><div class="example"><div class="codePanel"><h4>Example:</h4><textarea class="code" rows="12" cols="60" wrap="off">
 const res = await fetch(&#39;/fireworks.ogv&#39;);
 const reader = res.body.getReader();
 
