update jsdoc

raszi · Feb 4, 2020 · 9500e10 · 9500e10
1 parent 1746331
commit 9500e10
Show file tree

Hide file tree

Showing 4 changed files with 97 additions and 46 deletions.
diff --git a/docs/global.html b/docs/global.html
@@ -251,7 +251,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line305">line 305</a>
+        <a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line317">line 317</a>
     </li></ul></dd>
 
 
@@ -388,7 +388,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line333">line 333</a>
+        <a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line345">line 345</a>
     </li></ul></dd>
 
 
@@ -530,6 +530,12 @@ <h5>Parameters:</h5>
 <span class="param-type"><a href="global.html#Options">Options</a></span>
 |
 
+<span class="param-type">null</span>
+|
+
+<span class="param-type">undefined</span>
+|
+
 <span class="param-type"><a href="global.html#fileCallback">fileCallback</a></span>
 
 
@@ -548,7 +554,7 @@ <h5>Parameters:</h5>
 
 
 
-            <td class="description last">the config options or the callback function</td>
+            <td class="description last">the config options or the callback function or null or undefined</td>
         </tr>
 
 
@@ -622,7 +628,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line240">line 240</a>
+        <a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line252">line 252</a>
     </li></ul></dd>
 
 
@@ -759,7 +765,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line278">line 278</a>
+        <a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line290">line 290</a>
     </li></ul></dd>
 
 
@@ -898,7 +904,7 @@ <h4 class="name" id="isEBADF"><span class="type-signature"></span>isEBADF<span c
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line501">line 501</a>
+        <a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line513">line 513</a>
     </li></ul></dd>
 
 
@@ -986,7 +992,7 @@ <h4 class="name" id="isENOENT"><span class="type-signature"></span>isENOENT<span
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line508">line 508</a>
+        <a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line520">line 520</a>
     </li></ul></dd>
 
 
@@ -1091,7 +1097,7 @@ <h4 class="name" id="isExpectedError"><span class="type-signature"></span>isExpe
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line532">line 532</a>
+        <a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line544">line 544</a>
     </li></ul></dd>
 
 
@@ -1179,7 +1185,7 @@ <h4 class="name" id="setGracefulCleanup"><span class="type-signature"></span>set
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line550">line 550</a>
+        <a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line562">line 562</a>
     </li></ul></dd>
 
 
@@ -1362,7 +1368,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line164">line 164</a>
+        <a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line176">line 176</a>
     </li></ul></dd>
 
 
@@ -1499,7 +1505,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line208">line 208</a>
+        <a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line220">line 220</a>
     </li></ul></dd>
 
 
@@ -1705,7 +1711,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line629">line 629</a>
+        <a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line642">line 642</a>
     </li></ul></dd>
 
 
@@ -1793,7 +1799,7 @@ <h4 class="name" id="cleanupCallbackSync"><span class="type-signature"></span>cl
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line636">line 636</a>
+        <a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line649">line 649</a>
     </li></ul></dd>
 
 
@@ -2000,7 +2006,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line615">line 615</a>
+        <a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line628">line 628</a>
     </li></ul></dd>
 
 
@@ -2207,7 +2213,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line622">line 622</a>
+        <a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line635">line 635</a>
     </li></ul></dd>
 
 
@@ -2364,7 +2370,7 @@ <h5 class="subsection-title">Properties:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line587">line 587</a>
+        <a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line600">line 600</a>
     </li></ul></dd>
 
 
@@ -2516,7 +2522,7 @@ <h5>Parameters:</h5>
 
 
 
-            <td class="description last">the file descriptor</td>
+            <td class="description last">the file descriptor or -1 if the fd had been discarded</td>
         </tr>
 
 
@@ -2588,7 +2594,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line599">line 599</a>
+        <a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line612">line 612</a>
     </li></ul></dd>
 
 
@@ -2754,7 +2760,7 @@ <h5>Parameters:</h5>
 
 
 
-            <td class="description last">the file descriptor</td>
+            <td class="description last">the file descriptor or -1 if the fd had been discarded</td>
         </tr>
 
 
@@ -2826,7 +2832,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line607">line 607</a>
+        <a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line620">line 620</a>
     </li></ul></dd>
 
 
@@ -2944,7 +2950,7 @@ <h5 class="subsection-title">Properties:</h5>
 
 
 
-            <td class="description last">the file descriptor</td>
+            <td class="description last">the file descriptor or -1 if the fd has been discarded</td>
         </tr>
 
 
@@ -3006,7 +3012,7 @@ <h5 class="subsection-title">Properties:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line580">line 580</a>
+        <a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line593">line 593</a>
     </li></ul></dd>
 
 
@@ -3075,6 +3081,37 @@ <h5 class="subsection-title">Properties:</h5>
     <tbody>
 
 
+        <tr>
+
+                <td class="name"><code>keep</code></td>
+
+
+            <td class="type">
+
+
+<span class="param-type">boolean</span>
+
+
+
+            </td>
+
+
+                <td class="attributes">
+
+
+
+                    &lt;nullable><br>
+
+                </td>
+
+
+
+
+            <td class="description last">the temporary object (file or dir) will not be garbage collected</td>
+        </tr>
+
+
+
         <tr>
 
                 <td class="name"><code>tries</code></td>
@@ -3163,7 +3200,7 @@ <h5 class="subsection-title">Properties:</h5>
 
 
 
-            <td class="description last">fix name</td>
+            <td class="description last">fixed name relative to tmpdir or the specified dir option</td>
         </tr>
 
 
@@ -3194,7 +3231,7 @@ <h5 class="subsection-title">Properties:</h5>
 
 
 
-            <td class="description last">the tmp directory to use</td>
+            <td class="description last">tmp directory relative to the system tmp directory to use</td>
         </tr>
 
 
@@ -3326,7 +3363,7 @@ <h5 class="subsection-title">Properties:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line567">line 567</a>
+        <a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line579">line 579</a>
     </li></ul></dd>
 
 
@@ -3400,7 +3437,7 @@ <h4 class="name" id="simpleCallback"><span class="type-signature"></span>simpleC
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line642">line 642</a>
+        <a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line655">line 655</a>
     </li></ul></dd>
 
 
@@ -3583,7 +3620,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line593">line 593</a>
+        <a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line606">line 606</a>
     </li></ul></dd>
 
 
@@ -3633,7 +3670,7 @@ <h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.htm
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Mon Feb 03 2020 15:28:01 GMT+0100 (GMT+01:00)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Wed Feb 05 2020 00:38:39 GMT+0100 (GMT+01:00)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/index.html b/docs/index.html
@@ -316,7 +316,7 @@ <h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.htm
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Mon Feb 03 2020 15:28:01 GMT+0100 (GMT+01:00)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Wed Feb 05 2020 00:38:39 GMT+0100 (GMT+01:00)
 </footer>
 
 <script> prettyPrint(); </script>