Update docs

debagger · Mar 11, 2021 · 36fa18f · 36fa18f
1 parent ec429fe
commit 36fa18f
Show file tree

Hide file tree

Showing 18 changed files with 360 additions and 35 deletions.
diff --git a/docs/FSAsyncIterable.html b/docs/FSAsyncIterable.html
@@ -66,7 +66,7 @@
 
  <nav>
 
- <h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Classes</h3><ul><li><a href="FSAsyncIterable.html">FSAsyncIterable</a></li><li><a href="FSDir.html">FSDir</a></li><li><a href="FSDirent.html">FSDirent</a></li><li><a href="FSFile.html">FSFile</a></li><li><a href="FSFileHash.html">FSFileHash</a></li><li><a href="FSFileRead.html">FSFileRead</a></li><li><a href="FSFileWrite.html">FSFileWrite</a></li><li><a href="FSIterable.html">FSIterable</a></li></ul><h3>Global</h3><ul><li><a href="global.html#cwd">cwd</a></li><li><a href="global.html#dirname">dirname</a></li><li><a href="global.html#envPath">envPath</a></li><li><a href="global.html#FSPath">FSPath</a></li><li><a href="global.html#home">home</a></li><li><a href="global.html#mkdtemp">mkdtemp</a></li><li><a href="global.html#range">range</a></li><li><a href="global.html#tmp">tmp</a></li></ul></div>
+ <h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Classes</h3><ul><li><a href="FSAsyncIterable.html">FSAsyncIterable</a></li><li><a href="FSDir.html">FSDir</a></li><li><a href="FSDirent.html">FSDirent</a></li><li><a href="FSFile.html">FSFile</a></li><li><a href="FSFileHash.html">FSFileHash</a></li><li><a href="FSFileRead.html">FSFileRead</a></li><li><a href="FSIterable.html">FSIterable</a></li></ul><h3>Interfaces</h3><ul><li><a href="PromiseLikeWriteStream.html">PromiseLikeWriteStream</a></li></ul><h3>Global</h3><ul><li><a href="global.html#cwd">cwd</a></li><li><a href="global.html#dirname">dirname</a></li><li><a href="global.html#envPath">envPath</a></li><li><a href="global.html#FSPath">FSPath</a></li><li><a href="global.html#home">home</a></li><li><a href="global.html#mkdtemp">mkdtemp</a></li><li><a href="global.html#range">range</a></li><li><a href="global.html#tmp">tmp</a></li></ul></div>
 
  </nav>
  </div>
@@ -236,7 +236,7 @@ <h4 class="name" id="filter">
 
  <span class="code-name">
 
- filter<span class="signature">(callback)</span><span class="type-signature"></span>
+ filter<span class="signature">(callback, parallel)</span><span class="type-signature"></span>
 
  </span>
  </h4>
@@ -272,6 +272,8 @@ <h5>Parameters:</h5>
 
 
 
+ <th>Default</th>
+
 
  <th class="last">Description</th>
  </tr>
@@ -293,12 +295,42 @@ <h5>Parameters:</h5>
 
 
 
+ <td class="default">
+
+ </td>
+
 
  <td class="description last">async function (must return Promise).</td>
 </tr>
 
 
 
+
+
+<tr class="deep-level-0">
+
+ <td class="name"><code>parallel</code></td>
+
+
+ <td class="type">
+
+ </td>
+
+
+
+
+ <td class="default">
+
+ 1
+
+ </td>
+
+
+ <td class="description last">number of callbacks runs in parallel</td>
+</tr>
+
+
+
  </tbody>
  </table>
 </div>
@@ -342,7 +374,7 @@ <h5>Parameters:</h5>
  <p class="tag-source">
  <a href="fs-async-iterable.class.ts.html" class="button">View Source</a>
  <span>
- <a href="fs-async-iterable.class.ts.html">fs-async-iterable.class.ts</a>, <a href="fs-async-iterable.class.ts.html#line30">line 30</a>
+ <a href="fs-async-iterable.class.ts.html">fs-async-iterable.class.ts</a>, <a href="fs-async-iterable.class.ts.html#line57">line 57</a>
  </span>
  </p>
 
@@ -521,7 +553,7 @@ <h5>Parameters:</h5>
  <p class="tag-source">
  <a href="fs-async-iterable.class.ts.html" class="button">View Source</a>
  <span>
- <a href="fs-async-iterable.class.ts.html">fs-async-iterable.class.ts</a>, <a href="fs-async-iterable.class.ts.html#line62">line 62</a>
+ <a href="fs-async-iterable.class.ts.html">fs-async-iterable.class.ts</a>, <a href="fs-async-iterable.class.ts.html#line116">line 116</a>
  </span>
  </p>
 
@@ -558,7 +590,7 @@ <h4 class="name" id="map">
 
  <span class="code-name">
 
- map<span class="signature">(callback)</span><span class="type-signature"></span>
+ map<span class="signature">(callback, parallel)</span><span class="type-signature"></span>
 
  </span>
  </h4>
@@ -594,6 +626,8 @@ <h5>Parameters:</h5>
 
 
 
+ <th>Default</th>
+
 
  <th class="last">Description</th>
  </tr>
@@ -615,12 +649,42 @@ <h5>Parameters:</h5>
 
 
 
+ <td class="default">
+
+ </td>
+
 
  <td class="description last">async function (must return Promise),which transform input item to output item</td>
 </tr>
 
 
 
+
+
+<tr class="deep-level-0">
+
+ <td class="name"><code>parallel</code></td>
+
+
+ <td class="type">
+
+ </td>
+
+
+
+
+ <td class="default">
+
+ 1
+
+ </td>
+
+
+ <td class="description last">number of callbacks runs in parallel</td>
+</tr>
+
+
+
  </tbody>
  </table>
 </div>
@@ -664,7 +728,7 @@ <h5>Parameters:</h5>
  <p class="tag-source">
  <a href="fs-async-iterable.class.ts.html" class="button">View Source</a>
  <span>
- <a href="fs-async-iterable.class.ts.html">fs-async-iterable.class.ts</a>, <a href="fs-async-iterable.class.ts.html#line17">line 17</a>
+ <a href="fs-async-iterable.class.ts.html">fs-async-iterable.class.ts</a>, <a href="fs-async-iterable.class.ts.html#line18">line 18</a>
  </span>
  </p>
 
@@ -831,7 +895,7 @@ <h5>Parameters:</h5>
  <p class="tag-source">
  <a href="fs-async-iterable.class.ts.html" class="button">View Source</a>
  <span>
- <a href="fs-async-iterable.class.ts.html">fs-async-iterable.class.ts</a>, <a href="fs-async-iterable.class.ts.html#line50">line 50</a>
+ <a href="fs-async-iterable.class.ts.html">fs-async-iterable.class.ts</a>, <a href="fs-async-iterable.class.ts.html#line104">line 104</a>
  </span>
  </p>
 
@@ -932,7 +996,7 @@ <h4 class="name" id="toArray">
  <p class="tag-source">
  <a href="fs-async-iterable.class.ts.html" class="button">View Source</a>
  <span>
- <a href="fs-async-iterable.class.ts.html">fs-async-iterable.class.ts</a>, <a href="fs-async-iterable.class.ts.html#line82">line 82</a>
+ <a href="fs-async-iterable.class.ts.html">fs-async-iterable.class.ts</a>, <a href="fs-async-iterable.class.ts.html#line136">line 136</a>
  </span>
  </p>
 

diff --git a/docs/FSDir.html b/docs/FSDir.html
@@ -66,7 +66,7 @@
 
  <nav>
 
- <h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Classes</h3><ul><li><a href="FSAsyncIterable.html">FSAsyncIterable</a></li><li><a href="FSDir.html">FSDir</a></li><li><a href="FSDirent.html">FSDirent</a></li><li><a href="FSFile.html">FSFile</a></li><li><a href="FSFileHash.html">FSFileHash</a></li><li><a href="FSFileRead.html">FSFileRead</a></li><li><a href="FSFileWrite.html">FSFileWrite</a></li><li><a href="FSIterable.html">FSIterable</a></li></ul><h3>Global</h3><ul><li><a href="global.html#cwd">cwd</a></li><li><a href="global.html#dirname">dirname</a></li><li><a href="global.html#envPath">envPath</a></li><li><a href="global.html#FSPath">FSPath</a></li><li><a href="global.html#home">home</a></li><li><a href="global.html#mkdtemp">mkdtemp</a></li><li><a href="global.html#range">range</a></li><li><a href="global.html#tmp">tmp</a></li></ul></div>
+ <h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Classes</h3><ul><li><a href="FSAsyncIterable.html">FSAsyncIterable</a></li><li><a href="FSDir.html">FSDir</a></li><li><a href="FSDirent.html">FSDirent</a></li><li><a href="FSFile.html">FSFile</a></li><li><a href="FSFileHash.html">FSFileHash</a></li><li><a href="FSFileRead.html">FSFileRead</a></li><li><a href="FSIterable.html">FSIterable</a></li></ul><h3>Interfaces</h3><ul><li><a href="PromiseLikeWriteStream.html">PromiseLikeWriteStream</a></li></ul><h3>Global</h3><ul><li><a href="global.html#cwd">cwd</a></li><li><a href="global.html#dirname">dirname</a></li><li><a href="global.html#envPath">envPath</a></li><li><a href="global.html#FSPath">FSPath</a></li><li><a href="global.html#home">home</a></li><li><a href="global.html#mkdtemp">mkdtemp</a></li><li><a href="global.html#range">range</a></li><li><a href="global.html#tmp">tmp</a></li></ul></div>
 
  </nav>
  </div>

diff --git a/docs/FSDirent.html b/docs/FSDirent.html
@@ -66,7 +66,7 @@
 
  <nav>
 
- <h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Classes</h3><ul><li><a href="FSAsyncIterable.html">FSAsyncIterable</a></li><li><a href="FSDir.html">FSDir</a></li><li><a href="FSDirent.html">FSDirent</a></li><li><a href="FSFile.html">FSFile</a></li><li><a href="FSFileHash.html">FSFileHash</a></li><li><a href="FSFileRead.html">FSFileRead</a></li><li><a href="FSFileWrite.html">FSFileWrite</a></li><li><a href="FSIterable.html">FSIterable</a></li></ul><h3>Global</h3><ul><li><a href="global.html#cwd">cwd</a></li><li><a href="global.html#dirname">dirname</a></li><li><a href="global.html#envPath">envPath</a></li><li><a href="global.html#FSPath">FSPath</a></li><li><a href="global.html#home">home</a></li><li><a href="global.html#mkdtemp">mkdtemp</a></li><li><a href="global.html#range">range</a></li><li><a href="global.html#tmp">tmp</a></li></ul></div>
+ <h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Classes</h3><ul><li><a href="FSAsyncIterable.html">FSAsyncIterable</a></li><li><a href="FSDir.html">FSDir</a></li><li><a href="FSDirent.html">FSDirent</a></li><li><a href="FSFile.html">FSFile</a></li><li><a href="FSFileHash.html">FSFileHash</a></li><li><a href="FSFileRead.html">FSFileRead</a></li><li><a href="FSIterable.html">FSIterable</a></li></ul><h3>Interfaces</h3><ul><li><a href="PromiseLikeWriteStream.html">PromiseLikeWriteStream</a></li></ul><h3>Global</h3><ul><li><a href="global.html#cwd">cwd</a></li><li><a href="global.html#dirname">dirname</a></li><li><a href="global.html#envPath">envPath</a></li><li><a href="global.html#FSPath">FSPath</a></li><li><a href="global.html#home">home</a></li><li><a href="global.html#mkdtemp">mkdtemp</a></li><li><a href="global.html#range">range</a></li><li><a href="global.html#tmp">tmp</a></li></ul></div>
 
  </nav>
  </div>

diff --git a/docs/FSFile.html b/docs/FSFile.html
@@ -66,7 +66,7 @@
 
  <nav>
 
- <h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Classes</h3><ul><li><a href="FSAsyncIterable.html">FSAsyncIterable</a></li><li><a href="FSDir.html">FSDir</a></li><li><a href="FSDirent.html">FSDirent</a></li><li><a href="FSFile.html">FSFile</a></li><li><a href="FSFileHash.html">FSFileHash</a></li><li><a href="FSFileRead.html">FSFileRead</a></li><li><a href="FSFileWrite.html">FSFileWrite</a></li><li><a href="FSIterable.html">FSIterable</a></li></ul><h3>Global</h3><ul><li><a href="global.html#cwd">cwd</a></li><li><a href="global.html#dirname">dirname</a></li><li><a href="global.html#envPath">envPath</a></li><li><a href="global.html#FSPath">FSPath</a></li><li><a href="global.html#home">home</a></li><li><a href="global.html#mkdtemp">mkdtemp</a></li><li><a href="global.html#range">range</a></li><li><a href="global.html#tmp">tmp</a></li></ul></div>
+ <h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Classes</h3><ul><li><a href="FSAsyncIterable.html">FSAsyncIterable</a></li><li><a href="FSDir.html">FSDir</a></li><li><a href="FSDirent.html">FSDirent</a></li><li><a href="FSFile.html">FSFile</a></li><li><a href="FSFileHash.html">FSFileHash</a></li><li><a href="FSFileRead.html">FSFileRead</a></li><li><a href="FSIterable.html">FSIterable</a></li></ul><h3>Interfaces</h3><ul><li><a href="PromiseLikeWriteStream.html">PromiseLikeWriteStream</a></li></ul><h3>Global</h3><ul><li><a href="global.html#cwd">cwd</a></li><li><a href="global.html#dirname">dirname</a></li><li><a href="global.html#envPath">envPath</a></li><li><a href="global.html#FSPath">FSPath</a></li><li><a href="global.html#home">home</a></li><li><a href="global.html#mkdtemp">mkdtemp</a></li><li><a href="global.html#range">range</a></li><li><a href="global.html#tmp">tmp</a></li></ul></div>
 
  </nav>
  </div>

diff --git a/docs/FSFileHash.html b/docs/FSFileHash.html
@@ -66,7 +66,7 @@
 
  <nav>
 
- <h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Classes</h3><ul><li><a href="FSAsyncIterable.html">FSAsyncIterable</a></li><li><a href="FSDir.html">FSDir</a></li><li><a href="FSDirent.html">FSDirent</a></li><li><a href="FSFile.html">FSFile</a></li><li><a href="FSFileHash.html">FSFileHash</a></li><li><a href="FSFileRead.html">FSFileRead</a></li><li><a href="FSFileWrite.html">FSFileWrite</a></li><li><a href="FSIterable.html">FSIterable</a></li></ul><h3>Global</h3><ul><li><a href="global.html#cwd">cwd</a></li><li><a href="global.html#dirname">dirname</a></li><li><a href="global.html#envPath">envPath</a></li><li><a href="global.html#FSPath">FSPath</a></li><li><a href="global.html#home">home</a></li><li><a href="global.html#mkdtemp">mkdtemp</a></li><li><a href="global.html#range">range</a></li><li><a href="global.html#tmp">tmp</a></li></ul></div>
+ <h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Classes</h3><ul><li><a href="FSAsyncIterable.html">FSAsyncIterable</a></li><li><a href="FSDir.html">FSDir</a></li><li><a href="FSDirent.html">FSDirent</a></li><li><a href="FSFile.html">FSFile</a></li><li><a href="FSFileHash.html">FSFileHash</a></li><li><a href="FSFileRead.html">FSFileRead</a></li><li><a href="FSIterable.html">FSIterable</a></li></ul><h3>Interfaces</h3><ul><li><a href="PromiseLikeWriteStream.html">PromiseLikeWriteStream</a></li></ul><h3>Global</h3><ul><li><a href="global.html#cwd">cwd</a></li><li><a href="global.html#dirname">dirname</a></li><li><a href="global.html#envPath">envPath</a></li><li><a href="global.html#FSPath">FSPath</a></li><li><a href="global.html#home">home</a></li><li><a href="global.html#mkdtemp">mkdtemp</a></li><li><a href="global.html#range">range</a></li><li><a href="global.html#tmp">tmp</a></li></ul></div>
 
  </nav>
  </div>

diff --git a/docs/FSFileRead.html b/docs/FSFileRead.html
@@ -66,7 +66,7 @@
 
  <nav>
 
- <h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Classes</h3><ul><li><a href="FSAsyncIterable.html">FSAsyncIterable</a></li><li><a href="FSDir.html">FSDir</a></li><li><a href="FSDirent.html">FSDirent</a></li><li><a href="FSFile.html">FSFile</a></li><li><a href="FSFileHash.html">FSFileHash</a></li><li><a href="FSFileRead.html">FSFileRead</a></li><li><a href="FSFileWrite.html">FSFileWrite</a></li><li><a href="FSIterable.html">FSIterable</a></li></ul><h3>Global</h3><ul><li><a href="global.html#cwd">cwd</a></li><li><a href="global.html#dirname">dirname</a></li><li><a href="global.html#envPath">envPath</a></li><li><a href="global.html#FSPath">FSPath</a></li><li><a href="global.html#home">home</a></li><li><a href="global.html#mkdtemp">mkdtemp</a></li><li><a href="global.html#range">range</a></li><li><a href="global.html#tmp">tmp</a></li></ul></div>
+ <h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Classes</h3><ul><li><a href="FSAsyncIterable.html">FSAsyncIterable</a></li><li><a href="FSDir.html">FSDir</a></li><li><a href="FSDirent.html">FSDirent</a></li><li><a href="FSFile.html">FSFile</a></li><li><a href="FSFileHash.html">FSFileHash</a></li><li><a href="FSFileRead.html">FSFileRead</a></li><li><a href="FSIterable.html">FSIterable</a></li></ul><h3>Interfaces</h3><ul><li><a href="PromiseLikeWriteStream.html">PromiseLikeWriteStream</a></li></ul><h3>Global</h3><ul><li><a href="global.html#cwd">cwd</a></li><li><a href="global.html#dirname">dirname</a></li><li><a href="global.html#envPath">envPath</a></li><li><a href="global.html#FSPath">FSPath</a></li><li><a href="global.html#home">home</a></li><li><a href="global.html#mkdtemp">mkdtemp</a></li><li><a href="global.html#range">range</a></li><li><a href="global.html#tmp">tmp</a></li></ul></div>
 
  </nav>
  </div>

diff --git a/docs/FSIterable.html b/docs/FSIterable.html
@@ -66,7 +66,7 @@
 
  <nav>
 
- <h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Classes</h3><ul><li><a href="FSAsyncIterable.html">FSAsyncIterable</a></li><li><a href="FSDir.html">FSDir</a></li><li><a href="FSDirent.html">FSDirent</a></li><li><a href="FSFile.html">FSFile</a></li><li><a href="FSFileHash.html">FSFileHash</a></li><li><a href="FSFileRead.html">FSFileRead</a></li><li><a href="FSFileWrite.html">FSFileWrite</a></li><li><a href="FSIterable.html">FSIterable</a></li></ul><h3>Global</h3><ul><li><a href="global.html#cwd">cwd</a></li><li><a href="global.html#dirname">dirname</a></li><li><a href="global.html#envPath">envPath</a></li><li><a href="global.html#FSPath">FSPath</a></li><li><a href="global.html#home">home</a></li><li><a href="global.html#mkdtemp">mkdtemp</a></li><li><a href="global.html#range">range</a></li><li><a href="global.html#tmp">tmp</a></li></ul></div>
+ <h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Classes</h3><ul><li><a href="FSAsyncIterable.html">FSAsyncIterable</a></li><li><a href="FSDir.html">FSDir</a></li><li><a href="FSDirent.html">FSDirent</a></li><li><a href="FSFile.html">FSFile</a></li><li><a href="FSFileHash.html">FSFileHash</a></li><li><a href="FSFileRead.html">FSFileRead</a></li><li><a href="FSIterable.html">FSIterable</a></li></ul><h3>Interfaces</h3><ul><li><a href="PromiseLikeWriteStream.html">PromiseLikeWriteStream</a></li></ul><h3>Global</h3><ul><li><a href="global.html#cwd">cwd</a></li><li><a href="global.html#dirname">dirname</a></li><li><a href="global.html#envPath">envPath</a></li><li><a href="global.html#FSPath">FSPath</a></li><li><a href="global.html#home">home</a></li><li><a href="global.html#mkdtemp">mkdtemp</a></li><li><a href="global.html#range">range</a></li><li><a href="global.html#tmp">tmp</a></li></ul></div>
 
  </nav>
  </div>