Skip to content

Commit

Permalink
update jsdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
@silkentrance
silkentrance committed Feb 3, 2020
1 parent b63cb58 commit 1746331
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 41 deletions.
38 changes: 19 additions & 19 deletions docs/global.html
View file
Expand Up @@ -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#line320">line 320</a>
<a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line305">line 305</a>
</li></ul></dd>


Expand Down Expand Up @@ -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#line348">line 348</a>
<a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line333">line 333</a>
</li></ul></dd>


Expand Down Expand Up @@ -759,7 +759,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#line293">line 293</a>
<a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line278">line 278</a>
</li></ul></dd>


Expand Down Expand Up @@ -898,7 +898,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#line516">line 516</a>
<a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line501">line 501</a>
</li></ul></dd>


Expand Down Expand Up @@ -986,7 +986,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#line523">line 523</a>
<a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line508">line 508</a>
</li></ul></dd>


Expand Down Expand Up @@ -1091,7 +1091,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#line547">line 547</a>
<a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line532">line 532</a>
</li></ul></dd>


Expand Down Expand Up @@ -1179,7 +1179,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#line565">line 565</a>
<a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line550">line 550</a>
</li></ul></dd>


Expand Down Expand Up @@ -1705,7 +1705,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#line644">line 644</a>
<a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line629">line 629</a>
</li></ul></dd>


Expand Down Expand Up @@ -1793,7 +1793,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#line651">line 651</a>
<a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line636">line 636</a>
</li></ul></dd>


Expand Down Expand Up @@ -2000,7 +2000,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#line630">line 630</a>
<a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line615">line 615</a>
</li></ul></dd>


Expand Down Expand Up @@ -2207,7 +2207,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#line637">line 637</a>
<a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line622">line 622</a>
</li></ul></dd>


Expand Down Expand Up @@ -2364,7 +2364,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#line602">line 602</a>
<a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line587">line 587</a>
</li></ul></dd>


Expand Down Expand Up @@ -2588,7 +2588,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#line614">line 614</a>
<a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line599">line 599</a>
</li></ul></dd>


Expand Down Expand Up @@ -2826,7 +2826,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#line607">line 607</a>
</li></ul></dd>


Expand Down Expand Up @@ -3006,7 +3006,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#line595">line 595</a>
<a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line580">line 580</a>
</li></ul></dd>


Expand Down Expand Up @@ -3326,7 +3326,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#line582">line 582</a>
<a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line567">line 567</a>
</li></ul></dd>


Expand Down Expand Up @@ -3400,7 +3400,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#line657">line 657</a>
<a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line642">line 642</a>
</li></ul></dd>


Expand Down Expand Up @@ -3583,7 +3583,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#line608">line 608</a>
<a href="tmp.js.html">tmp.js</a>, <a href="tmp.js.html#line593">line 593</a>
</li></ul></dd>


Expand Down Expand Up @@ -3633,7 +3633,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 14:17:06 GMT+0100 (GMT+01:00)
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)
</footer>

<script> prettyPrint(); </script>
Expand Down
3 changes: 2 additions & 1 deletion docs/index.html
View file
Expand Up @@ -64,6 +64,7 @@ <h2>About</h2>
<p>If you do not want to store your temporary directories and files in the
standard OS temporary directory, then you are free to override that as well.</p>
<h2>An Important Note on Compatibility</h2>
<p>See the <a href="./CHANGELOG.md">CHANGELOG</a> for more information.</p>
<h3>Version 0.1.0</h3>
<p>Since version 0.1.0, all support for node versions &lt; 0.10.0 has been dropped.</p>
<p>Most importantly, any support for earlier versions of node-tmp was also dropped.</p>
Expand Down Expand Up @@ -315,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 14:17:06 GMT+0100 (GMT+01:00)
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)
</footer>

<script> prettyPrint(); </script>
Expand Down
27 changes: 6 additions & 21 deletions docs/tmp.js.html
View file
Expand Up @@ -281,29 +281,14 @@ <h1 class="page-title">Source: tmp.js</h1>
/* istanbul ignore else */
if (err) return cb(err);

// FIXME overall handling of opts.discardDescriptor is off
if (opts.discardDescriptor) {
// FIXME? must not unlink as the user expects the filename to be reserved
return fs.close(fd, function _discardCallback(err) {
/* istanbul ignore else */
if (err) {
// Low probability, and the file exists, so this could be
// ignored. If it isn't we certainly need to unlink the
// file, and if that fails too its error is more
// important.
try {
fs.unlinkSync(name);
} catch (e) {
if (!isENOENT(e)) {
err = e;
}
}
return cb(err);
}
cb(null, name, undefined, _prepareTmpFileRemoveCallback(name, -1, opts));
return fs.close(fd, function _discardCallback(possibleErr) {
// the chance of getting an error on close here is rather low and might occur in the most edgiest cases only
return cb(possibleErr, name, undefined, _prepareTmpFileRemoveCallback(name, -1, opts, false));
});
} else {
// FIXME detachDescriptor passes the descriptor whereas discardDescriptor closes it
// detachDescriptor passes the descriptor whereas discardDescriptor closes it, either way, we no longer care
// about the descriptor
const discardOrDetachDescriptor = opts.discardDescriptor || opts.detachDescriptor;
cb(null, name, fd, _prepareTmpFileRemoveCallback(name, discardOrDetachDescriptor ? -1 : fd, opts, false));
}
Expand Down Expand Up @@ -727,7 +712,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 14:17:06 GMT+0100 (GMT+01:00)
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)
</footer>

<script> prettyPrint(); </script>
Expand Down

0 comments on commit 1746331

Please sign in to comment.