docs/global.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Global</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Global</h1>

    
<section>

<header>
    
        <h2></h2>
        
    
</header>

<article>
    <div class="container-overview">
    
        
<dl class="details">

    
</dl>


    </div>

    
        <h3 class="subsection-title">Methods</h3>

        
    <h4 class="name" id="dir"><span class="type-signature"></span>dir<span class="signature">(options, callback<span class="signature-attributes">nullable</span>)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Creates a temporary directory.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#Options">Options</a></span>
|

<span class="param-type"><a href="global.html#dirCallback">dirCallback</a></span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">the options or the callback function</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>callback</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#dirCallback">dirCallback</a></span>


            </td>

            
                <td class="attributes">
                

                    &lt;nullable><br>
                

                </td>
            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <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#line210">line 210</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="dirSync"><span class="type-signature"></span>dirSync<span class="signature">(options)</span><span class="type-signature"> &rarr; {<a href="global.html#DirSyncObject">DirSyncObject</a>}</span></h4>
    

<div class="description">
    Synchronous version of dir.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#Options">Options</a></span>


            </td>

            
            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <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#line238">line 238</a>
    </li></ul></dd>
    

</dl>


<h5>Throws:</h5>

        
<dl>
    <dt>
        <div class="param-desc">
        if it cannot create a directory
        </div>
    </dt>
    <dd></dd>
    <dt>
        <dl>
            <dt>
                Type
            </dt>
            <dd>
                
<span class="param-type">Error</span>


            </dd>
        </dl>
    </dt>
    <dd></dd>
</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    object consists of name and removeCallback
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="global.html#DirSyncObject">DirSyncObject</a></span>


    </dd>
</dl>

    
    <h4 class="name" id="file"><span class="type-signature"></span>file<span class="signature">(options, callback<span class="signature-attributes">nullable</span>)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Creates and opens a temporary file.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<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>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">the config options or the callback function or null or undefined</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>callback</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#fileCallback">fileCallback</a></span>


            </td>

            
                <td class="attributes">
                

                    &lt;nullable><br>
                

                </td>
            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <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#line145">line 145</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="fileSync"><span class="type-signature"></span>fileSync<span class="signature">(options)</span><span class="type-signature"> &rarr; {<a href="global.html#FileSyncObject">FileSyncObject</a>}</span></h4>
    

<div class="description">
    Synchronous version of file.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#Options">Options</a></span>


            </td>

            
            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <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#line183">line 183</a>
    </li></ul></dd>
    

</dl>


<h5>Throws:</h5>

        
<dl>
    <dt>
        <div class="param-desc">
        if cannot create a file
        </div>
    </dt>
    <dd></dd>
    <dt>
        <dl>
            <dt>
                Type
            </dt>
            <dd>
                
<span class="param-type">Error</span>


            </dd>
        </dl>
    </dt>
    <dd></dd>
</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    object consists of name, fd and removeCallback
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="global.html#FileSyncObject">FileSyncObject</a></span>


    </dd>
</dl>

    
    <h4 class="name" id="setGracefulCleanup"><span class="type-signature"></span>setGracefulCleanup<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Sets the graceful cleanup.

If graceful cleanup is set, tmp will remove all controlled temporary objects on process exit, otherwise the
temporary objects will remain in place, waiting to be cleaned up on system restart or otherwise scheduled temporary
object removals.
</div>


<dl class="details">

    
    <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#line658">line 658</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="tmpName"><span class="type-signature"></span>tmpName<span class="signature">(options, callback<span class="signature-attributes">nullable</span>)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Gets a temporary file name.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#Options">Options</a></span>
|

<span class="param-type"><a href="global.html#tmpNameCallback">tmpNameCallback</a></span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">options or callback</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>callback</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#tmpNameCallback">tmpNameCallback</a></span>


            </td>

            
                <td class="attributes">
                

                    &lt;nullable><br>
                

                </td>
            

            <td class="description last">the callback function</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <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#line77">line 77</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="tmpNameSync"><span class="type-signature"></span>tmpNameSync<span class="signature">(options)</span><span class="type-signature"> &rarr; {string}</span></h4>
    

<div class="description">
    Synchronous version of tmpName.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <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#line119">line 119</a>
    </li></ul></dd>
    

</dl>


<h5>Throws:</h5>

        
<dl>
    <dt>
        <div class="param-desc">
        if the options are invalid or could not generate a filename
        </div>
    </dt>
    <dd></dd>
    <dt>
        <dl>
            <dt>
                Type
            </dt>
            <dd>
                
<span class="param-type">Error</span>


            </dd>
        </dl>
    </dt>
    <dd></dd>
</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    the generated random name
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">string</span>


    </dd>
</dl>

    
        <h3 class="subsection-title">Type Definitions</h3>

        
<h4 class="name" id="DirSyncObject">DirSyncObject</h4>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>


    <h5 class="subsection-title">Properties:</h5>

    
<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>name</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">the name of the directory</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>removeCallback</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#fileCallback">fileCallback</a></span>


            </td>

            
            <td class="description last">the callback function to remove the directory</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <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#line701">line 701</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="FileSyncObject">FileSyncObject</h4>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>


    <h5 class="subsection-title">Properties:</h5>

    
<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>name</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">the name of the file</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>fd</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last">the file descriptor or -1 if the fd has been discarded</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>removeCallback</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#fileCallback">fileCallback</a></span>


            </td>

            
            <td class="description last">the callback function to remove the file</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <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#line694">line 694</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="Options">Options</h4>


<div class="description">
    Configuration options.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>


    <h5 class="subsection-title">Properties:</h5>

    
<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <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>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
                <td class="attributes">
                

                    &lt;nullable><br>
                
                </td>
            

            <td class="description last">the number of tries before give up the name generation</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>(?int)</code></td>
            

            <td class="type">
            
            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">mode the access mode, defaults are 0o700 for directories and 0o600 for files</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>template</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                    &lt;nullable><br>
                
                </td>
            

            <td class="description last">the "mkstemp" like filename template</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>name</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                    &lt;nullable><br>
                
                </td>
            

            <td class="description last">fixed name relative to tmpdir or the specified dir option</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>dir</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                    &lt;nullable><br>
                
                </td>
            

            <td class="description last">tmp directory relative to the root tmp directory in use</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>prefix</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                    &lt;nullable><br>
                
                </td>
            

            <td class="description last">prefix for the generated name</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>postfix</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                    &lt;nullable><br>
                
                </td>
            

            <td class="description last">postfix for the generated name</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>tmpdir</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                    &lt;nullable><br>
                
                </td>
            

            <td class="description last">the root tmp directory which overrides the os tmpdir</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>unsafeCleanup</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            </td>

            
                <td class="attributes">
                

                    &lt;nullable><br>
                
                </td>
            

            <td class="description last">recursively removes the created temporary directory, even when it's not empty</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>detachDescriptor</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            </td>

            
                <td class="attributes">
                

                    &lt;nullable><br>
                
                </td>
            

            <td class="description last">detaches the file descriptor, caller is responsible for closing the file, tmp will no longer try closing the file during garbage collection</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>discardDescriptor</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            </td>

            
                <td class="attributes">
                

                    &lt;nullable><br>
                
                </td>
            

            <td class="description last">discards the file descriptor (closes file, fd is -1), tmp will no longer try closing the file during garbage collection</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <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#line676">line 676</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="cleanupCallback"><span class="type-signature"></span>cleanupCallback<span class="signature">(next<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
    

<div class="description">
    Removes the temporary created file or directory.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>next</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#simpleCallback">simpleCallback</a></span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">function to call whenever the tmp object needs to be removed</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <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#line743">line 743</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="cleanupCallbackSync"><span class="type-signature"></span>cleanupCallbackSync<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Removes the temporary created file or directory.
</div>


<dl class="details">

    
    <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#line750">line 750</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="dirCallback"><span class="type-signature"></span>dirCallback<span class="signature">(err<span class="signature-attributes">nullable</span>, name, fn)</span><span class="type-signature"></span></h4>
    

    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>err</code></td>
            

            <td class="type">
            
                
<span class="param-type">Error</span>


            </td>

            
                <td class="attributes">
                

                    &lt;nullable><br>
                

                </td>
            

            <td class="description last">the error object if anything goes wrong</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>name</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">the temporary file name</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>fn</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#cleanupCallback">cleanupCallback</a></span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">the cleanup callback function</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <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#line729">line 729</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="dirCallbackSync"><span class="type-signature"></span>dirCallbackSync<span class="signature">(err<span class="signature-attributes">nullable</span>, name, fn)</span><span class="type-signature"></span></h4>
    

    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>err</code></td>
            

            <td class="type">
            
                
<span class="param-type">Error</span>


            </td>

            
                <td class="attributes">
                

                    &lt;nullable><br>
                

                </td>
            

            <td class="description last">the error object if anything goes wrong</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>name</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">the temporary file name</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>fn</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#cleanupCallbackSync">cleanupCallbackSync</a></span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">the cleanup callback function</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <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#line736">line 736</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="fileCallback"><span class="type-signature"></span>fileCallback<span class="signature">(err<span class="signature-attributes">nullable</span>, name, fd, fn)</span><span class="type-signature"></span></h4>
    

    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>err</code></td>
            

            <td class="type">
            
                
<span class="param-type">Error</span>


            </td>

            
                <td class="attributes">
                

                    &lt;nullable><br>
                

                </td>
            

            <td class="description last">the error object if anything goes wrong</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>name</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">the temporary file name</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>fd</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">the file descriptor or -1 if the fd had been discarded</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>fn</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#cleanupCallback">cleanupCallback</a></span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">the cleanup callback function</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <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#line713">line 713</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="fileCallbackSync"><span class="type-signature"></span>fileCallbackSync<span class="signature">(err<span class="signature-attributes">nullable</span>, name, fd, fn)</span><span class="type-signature"></span></h4>
    

    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>err</code></td>
            

            <td class="type">
            
                
<span class="param-type">Error</span>


            </td>

            
                <td class="attributes">
                

                    &lt;nullable><br>
                

                </td>
            

            <td class="description last">the error object if anything goes wrong</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>name</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">the temporary file name</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>fd</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">the file descriptor or -1 if the fd had been discarded</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>fn</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#cleanupCallbackSync">cleanupCallbackSync</a></span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">the cleanup callback function</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <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#line721">line 721</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id="simpleCallback"><span class="type-signature"></span>simpleCallback<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    Callback function for function composition.
</div>


<dl class="details">

    
    <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#line756">line 756</a>
    </li></ul></dd>
    

    <dt class="tag-see">See:</dt>
    <dd class="tag-see">
        <ul>
            <li><a href="https://github.com/raszi/node-tmp/issues/57">raszi/node-tmp#57</a></li>
        </ul>
    </dd>
    

</dl>


    <h4 class="name" id="tmpNameCallback"><span class="type-signature"></span>tmpNameCallback<span class="signature">(err<span class="signature-attributes">nullable</span>, name)</span><span class="type-signature"></span></h4>
    

    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>err</code></td>
            

            <td class="type">
            
                
<span class="param-type">Error</span>


            </td>

            
                <td class="attributes">
                

                    &lt;nullable><br>
                

                </td>
            

            <td class="description last">the error object if anything goes wrong</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>name</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">the temporary file name</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <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#line707">line 707</a>
    </li></ul></dd>
    

</dl>


</article>

</section>


</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.html#dir">dir</a></li><li><a href="global.html#dirSync">dirSync</a></li><li><a href="global.html#file">file</a></li><li><a href="global.html#fileSync">fileSync</a></li><li><a href="global.html#setGracefulCleanup">setGracefulCleanup</a></li><li><a href="global.html#tmpName">tmpName</a></li><li><a href="global.html#tmpNameSync">tmpNameSync</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Wed Feb 28 2024 18:30:02 GMT-0700 (Mountain Standard Time)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>