Skip to content

Commit

Permalink
Task: Update latest docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nick spragg committed Feb 17, 2017
1 parent 1f9d718 commit 9b140ff
Show file tree
Hide file tree
Showing 4 changed files with 203 additions and 16 deletions.
177 changes: 167 additions & 10 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#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#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></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#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#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#rename">rename</a></li></ul></li></ul>
</nav>

<div id="main">
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#line372">line 372</a>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line402">line 402</a>
</li></ul></dd>


Expand Down Expand Up @@ -301,7 +301,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#line269">line 269</a>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line299">line 299</a>
</li></ul></dd>


Expand Down Expand Up @@ -401,7 +401,7 @@ <h4 class="name" id="getFiles"><span class="type-signature"></span>getFiles<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#line242">line 242</a>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line272">line 272</a>
</li></ul></dd>


Expand Down Expand Up @@ -505,7 +505,7 @@ <h4 class="name" id="getList"><span class="type-signature"></span>getList<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#line214">line 214</a>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line244">line 244</a>
</li></ul></dd>


Expand Down Expand Up @@ -609,7 +609,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#line190">line 190</a>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line220">line 220</a>
</li></ul></dd>


Expand Down Expand Up @@ -710,7 +710,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#line290">line 290</a>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line320">line 320</a>
</li></ul></dd>


Expand Down Expand Up @@ -810,7 +810,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#line163">line 163</a>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line119">line 119</a>
</li></ul></dd>


Expand Down Expand Up @@ -913,7 +913,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#line119">line 119</a>
<a href="file.js.html">file.js</a>, <a href="file.js.html#line163">line 163</a>
</li></ul></dd>


Expand Down Expand Up @@ -1370,6 +1370,163 @@ <h5>Example</h5>







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





<div class="description">
<p>Renames the abstract pathname</p>
</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>pathname</code></td>


<td class="type">


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

<span class="param-type"><a href="File.html">File</a></span>



</td>





<td class="description last"><p>pathname either as a string or File instance</p></td>
</tr>


</tbody>
</table>






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







</dl>













<h5>Returns:</h5>


<div class="param-desc">
<p>If the Promise fulfils, the fulfilment value is undefined</p>
</div>






<h5>Example</h5>

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

const original = File.create('fileA');
const renameTo = File.create('fileB');
original
.rename(renameTo)
.then(() => {
console.log(original.getName()) // prints fileA
});</code></pre>







Expand All @@ -1387,7 +1544,7 @@ <h5>Example</h5>
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Feb 13 2017 19:45:30 GMT+0000 (GMT) using the Minami theme.
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Feb 17 2017 13:23:57 GMT+0000 (GMT) using the Minami theme.
</footer>

<script>prettyPrint();</script>
Expand Down
34 changes: 32 additions & 2 deletions docs/file.js.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#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#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></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#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#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#rename">rename</a></li></ul></li></ul>
</nav>

<div id="main">
Expand Down Expand Up @@ -228,6 +228,36 @@ <h1 class="page-title">file.js</h1>
});
}

/**
* Renames the abstract pathname
*
* @instance
* @memberOf File
* @param {string|File} pathname - pathname either as a string or File instance
* @method
* rename
* @return If the Promise fulfils, the fulfilment value is undefined
* @example
* import File from 'file-js';
*
* const original = File.create('fileA');
* const renameTo = File.create('fileB');
* original
* .rename(renameTo)
* .then(() => {
* console.log(original.getName()) // prints fileA
* });
*/
rename(pathname) {
const newname = pathname instanceof File ? pathname.getName() : pathname;

return fsp
.renameAsync(this._pathname, newname)
.then(() => {
this._pathname = newname;
});
}

/**
* Synchronously get list of files, if pathname is a directory
*
Expand Down Expand Up @@ -441,7 +471,7 @@ <h1 class="page-title">file.js</h1>
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Feb 13 2017 19:45:30 GMT+0000 (GMT) using the Minami theme.
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Feb 17 2017 13:23:57 GMT+0000 (GMT) using the Minami theme.
</footer>

<script>prettyPrint();</script>
Expand Down
4 changes: 2 additions & 2 deletions docs/index.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#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#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></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#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#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#rename">rename</a></li></ul></li></ul>
</nav>

<div id="main">
Expand Down Expand Up @@ -121,7 +121,7 @@ <h2>Installation</h2><pre class="prettyprint source"><code>npm install --save fi
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Mon Feb 13 2017 19:45:30 GMT+0000 (GMT) using the Minami theme.
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Feb 17 2017 13:23:57 GMT+0000 (GMT) using the Minami theme.
</footer>

<script>prettyPrint();</script>
Expand Down
4 changes: 2 additions & 2 deletions src/file.js
View file
Expand Up @@ -201,10 +201,10 @@ class File {
*
* const original = File.create('fileA');
* const renameTo = File.create('fileB');
* file
* original
* .rename(renameTo)
* .then(() => {
* console.log(file.getName()) // prints fileA
* console.log(original.getName()) // prints fileA
* });
*/
rename(pathname) {
Expand Down

0 comments on commit 9b140ff

Please sign in to comment.