LumeWeb
/
filer
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update docs in README to reflect changes to mkdir, mkdirp. Also remove outdated reference to chmod/chown not existing.

This commit is contained in:
David Humphrey (:humph) david.humphrey@senecacollege.ca 2018-09-20 18:11:50 -04:00
parent f4231dd64f
commit 84c5433a28
1 changed files with 18 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -61,7 +61,6 @@ Filer is as close to the node.js [fs module](http://nodejs.org/api/fs.html) as p
with the following differences: with the following differences:
* No synchronous versions of methods (e.g., `mkdir()` but not `mkdirSync()`). * No synchronous versions of methods (e.g., `mkdir()` but not `mkdirSync()`).
* No permissions (e.g., no `chown()`, `chmod()`, etc.).
* No support for stream-based operations (e.g., `fs.ReadStream`, `fs.WriteStream`). * No support for stream-based operations (e.g., `fs.ReadStream`, `fs.WriteStream`).
Filer has other features lacking in node.js (e.g., swappable backend Filer has other features lacking in node.js (e.g., swappable backend
@ -305,7 +304,7 @@ var fs = new Filer.FileSystem();
* [fs.unlink(path, callback)](#unlink) * [fs.unlink(path, callback)](#unlink)
* [fs.mknod(path, mode, callback)](#mknod) * [fs.mknod(path, mode, callback)](#mknod)
* [fs.rmdir(path, callback)](#rmdir) * [fs.rmdir(path, callback)](#rmdir)
* [fs.mkdir(path, [mode], callback)](#mkdir) * [fs.mkdir(path, [options], callback)](#mkdir)
* [fs.readdir(path, callback)](#readdir) * [fs.readdir(path, callback)](#readdir)
* [fs.close(fd, callback)](#close) * [fs.close(fd, callback)](#close)
* [fs.open(path, flags, [mode], callback)](#open) * [fs.open(path, flags, [mode], callback)](#open)
@ -653,11 +652,15 @@ fs.unlink('/docs/a.txt', function(err) {
}); });
``` ```
#### fs.mkdir(path, [mode], callback)<a name="mkdir"></a> #### fs.mkdir(path, [options], callback)<a name="mkdir"></a>
Makes a directory with name supplied in `path` argument. Asynchronous [mkdir(2)](http://pubs.opengroup.org/onlinepubs/009695399/functions/mkdir.html). Callback gets no additional arguments. Makes a directory with name supplied in `path` argument. Asynchronous [mkdir(2)](http://pubs.opengroup.org/onlinepubs/009695399/functions/mkdir.html). Callback gets no additional arguments.
NOTE: Filer allows for, but ignores the optional `mode` argument used in node.js. `options` can be an `Object`, `Number`, or `String`. If a `Number` or `String`, it is
considered a `mode`. Note: Filer allows for a `mode`, but currently ignores it. If `options`
is an `Object`, it can contain: 1) `recursive` (`Boolean`) property, indicating whether or not
parent paths should first be created (defaults to `false`); 2) `mode` (`Number`/`String`) property,
indicating a `mode` as discussed above.
Example: Example:
@ -671,6 +674,12 @@ fs.mkdir('/home', function(err) {
// directory /home/carl now exists // directory /home/carl now exists
}); });
}); });
// Create /home/guest/tim recursively
fs.mkdir('/home/guest/tim', {recursive: true}, function(err) {
if(err) throw err;
// directories /home/guest/tim now exist
});
``` ```
#### fs.readdir(path, callback)<a name="readdir"></a> #### fs.readdir(path, callback)<a name="readdir"></a>
@ -1531,9 +1540,11 @@ sh.tempDir(function(err, tmp) {
#### sh.mkdirp(path, callback)<a name="mkdirp"></a> #### sh.mkdirp(path, callback)<a name="mkdirp"></a>
Recursively creates the directory at the provided path. If the Recursively creates the directory at the provided path. If the directory already
directory already exists, no error is returned. All parents must exists, no error is returned. All parents must be valid directories (not files).
be valid directories (not files).
NOTE: This is simply a convenience for calling [`fs.mkdir(path, {recursive: true}, callback)`](#mkdir),
which is the preferred way to accomplish recursive directory creation.
Example: Example: