| 1 | <p>File system API for Q when/defer-style promises</p>
|
| 2 |
|
| 3 | <p>Open options:</p>
|
| 4 |
|
| 5 | <ul>
|
| 6 | <li><code>flags</code>: <code>r</code>, <code>w</code>, <code>a</code>, <code>b</code></li>
|
| 7 | <li><code>charset</code>: default of <code>utf-8</code></li>
|
| 8 | <li><code>bufferSize</code>: in bytes</li>
|
| 9 | <li><code>mode</code>: UNIX permissions</li>
|
| 10 | <li><code>begin</code> first byte to read (defaults to zero)</li>
|
| 11 | <li><code>end</code> one past the last byte to read. <code>end - begin == length</code></li>
|
| 12 | </ul>
|
| 13 |
|
| 14 | <p>Functions:</p>
|
| 15 |
|
| 16 | <ul>
|
| 17 | <li><code>open(path, options)</code></li>
|
| 18 | <li><code>read(path, options)</code></li>
|
| 19 | <li><code>write(path, content, options)</code></li>
|
| 20 | <li><code>append(path, content, options)</code> NOT TESTED</li>
|
| 21 | <li><code>copy(source, target)</code> NOT IMPLEMENTED</li>
|
| 22 | <li><code>list(path)</code></li>
|
| 23 | <li><code>listTree(path, guard_opt(path, stat)</code>)</li>
|
| 24 | <li><code>listDirectoryTree(path)</code></li>
|
| 25 | <li><code>glob(pattern)</code> NOT IMPLEMENTED</li>
|
| 26 | <li><code>match(pattern, file)</code> NOT IMPLEMENTED</li>
|
| 27 | <li><code>makeDirectory(path)</code></li>
|
| 28 | <li><code>makeTree(path)</code> NOT TESTED</li>
|
| 29 | <li><code>remove(path)</code> NOT TESTED</li>
|
| 30 | <li><code>removeTree(path)</code> NOT TESTED</li>
|
| 31 | <li><code>link(source, taget)</code> NOT TESTED (probably safe)</li>
|
| 32 | <li><code>chown(path, uid, gid)</code> NOT TESTED (probably safe)</li>
|
| 33 | <li><code>chmod(path, mode)</code> NOT TESTED (probably safe)</li>
|
| 34 | <li><code>stat(path)</code></li>
|
| 35 | <li><code>statLink(path)</code> NOT TESTED</li>
|
| 36 | <li><code>statFd(fd)</code> NOT TESTED</li>
|
| 37 | <li><code>exists(path)</code></li>
|
| 38 | <li><code>isFile(path)</code></li>
|
| 39 | <li><code>isDirectory(path)</code></li>
|
| 40 | <li><code>lastModified(path)</code></li>
|
| 41 | <li><code>split(path)</code></li>
|
| 42 | <li><code>join(paths)</code></li>
|
| 43 | <li><code>join(...paths)</code></li>
|
| 44 | <li><code>resolve(...paths)</code></li>
|
| 45 | <li><code>normal(...paths)</code></li>
|
| 46 | <li><code>absolute(path)</code></li>
|
| 47 | <li><code>canonical(path)</code></li>
|
| 48 | <li><code>contains(parent, child)</code></li>
|
| 49 | <li><code>relative(source, target)</code></li>
|
| 50 | <li><code>relativeFromFile(source, target)</code></li>
|
| 51 | <li><code>relativeFromDirectory(source, target)</code></li>
|
| 52 | <li><code>isAbsolute(path)</code></li>
|
| 53 | <li><code>isRelative(path)</code></li>
|
| 54 | <li><code>isRoot(path)</code></li>
|
| 55 | <li><code>root(path)</code></li>
|
| 56 | <li><code>directory(path)</code></li>
|
| 57 | <li><code>base(path, extension)</code></li>
|
| 58 | <li><code>extension(path)</code></li>
|
| 59 | <li><code>reroot(path_opt)</code></li>
|
| 60 | <li><code>toObject(path_opt)</code></li>
|
| 61 | </ul>
|
| 62 |
|
| 63 | <p>Copyright 2009, 2010 Kristopher Michael Kowal
|
| 64 | MIT License (enclosed)</p> |
| \ | No newline at end of file |