Skip to content

Commit

Permalink
Task: Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nick spragg committed Mar 10, 2017
1 parent 39b351f commit 33fdf65
Show file tree
Hide file tree
Showing 3 changed files with 161 additions and 34 deletions.
145 changes: 123 additions & 22 deletions docs/File.html
View file
Expand Up @@ -24,7 +24,7 @@
<label for="nav-trigger" class="overlay"></label>

<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="File.html">File</a><ul class='methods'><li data-type='method'><a href="File.html#.create">create</a></li><li data-type='method'><a href="File.html#getAbsolutePath">getAbsolutePath</a></li><li data-type='method'><a href="File.html#getCanonicalPath">getCanonicalPath</a></li><li data-type='method'><a href="File.html#getDepthSync">getDepthSync</a></li><li data-type='method'><a href="File.html#getFiles">getFiles</a></li><li data-type='method'><a href="File.html#getList">getList</a></li><li data-type='method'><a href="File.html#getListSync">getListSync</a></li><li data-type='method'><a href="File.html#getName">getName</a></li><li data-type='method'><a href="File.html#getPathExtension">getPathExtension</a></li><li data-type='method'><a href="File.html#isDirectory">isDirectory</a></li><li data-type='method'><a href="File.html#isDirectory">isDirectory</a></li><li data-type='method'><a href="File.html#isDirectory">isDirectory</a></li><li data-type='method'><a href="File.html#isDirectorySync">isDirectorySync</a></li><li data-type='method'><a href="File.html#isFileSync">isFileSync</a></li><li data-type='method'><a href="File.html#isHiddenSync">isHiddenSync</a></li><li data-type='method'><a href="File.html#isSocket">isSocket</a></li><li data-type='method'><a href="File.html#issocketSync">issocketSync</a></li><li data-type='method'><a href="File.html#rename">rename</a></li><li data-type='method'><a href="File.html#withLock">withLock</a></li></ul></li></ul>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="File.html">File</a><ul class='methods'><li data-type='method'><a href="File.html#.create">create</a></li><li data-type='method'><a href="File.html#getAbsolutePath">getAbsolutePath</a></li><li data-type='method'><a href="File.html#getCanonicalPath">getCanonicalPath</a></li><li data-type='method'><a href="File.html#getDepthSync">getDepthSync</a></li><li data-type='method'><a href="File.html#getFiles">getFiles</a></li><li data-type='method'><a href="File.html#getFileSync">getFileSync</a></li><li data-type='method'><a href="File.html#getList">getList</a></li><li data-type='method'><a href="File.html#getListSync">getListSync</a></li><li data-type='method'><a href="File.html#getName">getName</a></li><li data-type='method'><a href="File.html#getPathExtension">getPathExtension</a></li><li data-type='method'><a href="File.html#isDirectory">isDirectory</a></li><li data-type='method'><a href="File.html#isDirectory">isDirectory</a></li><li data-type='method'><a href="File.html#isDirectory">isDirectory</a></li><li data-type='method'><a href="File.html#isDirectorySync">isDirectorySync</a></li><li data-type='method'><a href="File.html#isFileSync">isFileSync</a></li><li data-type='method'><a href="File.html#isHiddenSync">isHiddenSync</a></li><li data-type='method'><a href="File.html#isSocket">isSocket</a></li><li data-type='method'><a href="File.html#issocketSync">issocketSync</a></li><li data-type='method'><a href="File.html#rename">rename</a></li><li data-type='method'><a href="File.html#withLock">withLock</a></li></ul></li></ul>
</nav>

<div id="main">
Expand Down Expand Up @@ -102,7 +102,7 @@ <h4 class="name" id="File"><span class="type-signature"></span>new File<span cla

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line20">line 20</a>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line17">line 17</a>
</li></ul></dd>


Expand Down Expand Up @@ -202,7 +202,7 @@ <h4 class="name" id=".create"><span class="type-signature">(static) </span>creat

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line516">line 516</a>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line542">line 542</a>
</li></ul></dd>


Expand Down Expand Up @@ -301,7 +301,7 @@ <h4 class="name" id="getAbsolutePath"><span class="type-signature"></span>getAbs

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line392">line 392</a>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line418">line 418</a>
</li></ul></dd>


Expand Down Expand Up @@ -401,7 +401,7 @@ <h4 class="name" id="getCanonicalPath"><span class="type-signature"></span>getCa

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line413">line 413</a>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line439">line 439</a>
</li></ul></dd>


Expand Down Expand Up @@ -501,7 +501,7 @@ <h4 class="name" id="getDepthSync"><span class="type-signature"></span>getDepthS

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line353">line 353</a>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line379">line 379</a>
</li></ul></dd>


Expand Down Expand Up @@ -662,7 +662,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line316">line 316</a>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line313">line 313</a>
</li></ul></dd>


Expand Down Expand Up @@ -716,6 +716,107 @@ <h5>Example</h5>



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





<div class="description">
<p>Synchronously get list of file objects, if pathname is a directory</p>
</div>













<dl class="details">


























<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line350">line 350</a>
</li></ul></dd>







</dl>













<h5>Returns:</h5>


<div class="param-desc">
<p>array of files</p>
</div>






<h5>Example</h5>

<pre class="prettyprint"><code>import File from 'file-js';

const file = File.create('./myHiddenFile');
const files = file.getFileSync();
console.log(files);</code></pre>








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


Expand Down Expand Up @@ -828,7 +929,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line287">line 287</a>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line284">line 284</a>
</li></ul></dd>


Expand Down Expand Up @@ -933,7 +1034,7 @@ <h4 class="name" id="getListSync"><span class="type-signature"></span>getListSyn

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line263">line 263</a>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line260">line 260</a>
</li></ul></dd>


Expand Down Expand Up @@ -1034,7 +1135,7 @@ <h4 class="name" id="getName"><span class="type-signature"></span>getName<span c

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line374">line 374</a>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line400">line 400</a>
</li></ul></dd>


Expand Down Expand Up @@ -1134,7 +1235,7 @@ <h4 class="name" id="getPathExtension"><span class="type-signature"></span>getPa

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line431">line 431</a>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line457">line 457</a>
</li></ul></dd>


Expand Down Expand Up @@ -1234,7 +1335,7 @@ <h4 class="name" id="isDirectory"><span class="type-signature"></span>isDirector

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line206">line 206</a>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line203">line 203</a>
</li></ul></dd>


Expand Down Expand Up @@ -1337,7 +1438,7 @@ <h4 class="name" id="isDirectory"><span class="type-signature"></span>isDirector

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line118">line 118</a>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line115">line 115</a>
</li></ul></dd>


Expand Down Expand Up @@ -1440,7 +1541,7 @@ <h4 class="name" id="isDirectory"><span class="type-signature"></span>isDirector

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line162">line 162</a>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line159">line 159</a>
</li></ul></dd>


Expand Down Expand Up @@ -1543,7 +1644,7 @@ <h4 class="name" id="isDirectorySync"><span class="type-signature"></span>isDire

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line58">line 58</a>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line55">line 55</a>
</li></ul></dd>


Expand Down Expand Up @@ -1645,7 +1746,7 @@ <h4 class="name" id="isFileSync"><span class="type-signature"></span>isFileSync<

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line98">line 98</a>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line95">line 95</a>
</li></ul></dd>


Expand Down Expand Up @@ -1747,7 +1848,7 @@ <h4 class="name" id="isHiddenSync"><span class="type-signature"></span>isHiddenS

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line183">line 183</a>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line180">line 180</a>
</li></ul></dd>


Expand Down Expand Up @@ -1849,7 +1950,7 @@ <h4 class="name" id="isSocket"><span class="type-signature"></span>isSocket<span

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line140">line 140</a>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line137">line 137</a>
</li></ul></dd>


Expand Down Expand Up @@ -1952,7 +2053,7 @@ <h4 class="name" id="issocketSync"><span class="type-signature"></span>issocketS

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line78">line 78</a>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line75">line 75</a>
</li></ul></dd>


Expand Down Expand Up @@ -2106,7 +2207,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line233">line 233</a>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line230">line 230</a>
</li></ul></dd>


Expand Down Expand Up @@ -2211,7 +2312,7 @@ <h4 class="name" id="withLock"><span class="type-signature"></span>withLock<span

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line488">line 488</a>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line514">line 514</a>
</li></ul></dd>


Expand Down Expand Up @@ -2277,7 +2378,7 @@ <h5>Example</h5>
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Mar 10 2017 12:51:17 GMT+0000 (GMT) using the Minami theme.
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Mar 10 2017 16:37:02 GMT+0000 (GMT) using the Minami theme.
</footer>

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

0 comments on commit 33fdf65

Please sign in to comment.