vigour-fs
node's fs
module with sugar on top + native support.
This document describes only the sugar. For the meat and potatoes, refer to the nodejs docs.
Versioning
This module respects the semver versioning methodology
Installation
npm install vigour-fs
Usage
Same as node's fs
module, e.g.
var fs = ; fs
fs
"API"
Modification to node's All methods provided in vigour-fs
that also exist in fs
should behave exactly the same, except for these extra features:
- ### mkdirp option
fs.writeFile
accepts a mkdirp
option, which will create any missing subdirectories
fs
- ### read from URL
fs.readFile
and fs.writeFile
can accept a URL as path, in which case they will perform a GET request to that url.
fs
fs
This means fs.readFile
and fs.writeFile
come with extra options.
Option | Possible values | Default | Description |
---|---|---|---|
url |
|
true |
Whether to treat path as a url. If false, treats path as a local file path. Otherwise, treats path as a url if and only if it starts with http:// or https:// |
followRedirects |
|
true |
Whether to follow redirects (301, 302, 303, 305, 307, 308) |
maxTries | Positive integer above 0 | 1 |
Number of attempts to make in total. If over 1, will retry the request if the response's status code is 500 or 503. Use the retryOn404 option to retry on 404 as well (not recommended). |
retryDelay | Positive integer | 500 |
Time to wait before retrying the first time, in milliseconds. Subsequent attempts may use a different delay, dependant on the retryDelayType option. The delay may also be given by a 'retry-after' header accompanying a 503 response (see the respectRetryAfter option). In any case, the delay is capped by the maxRetryDelay option. |
retryDelayType |
|
exp |
Time to wait before retrying, in milliseconds, as a function of the attempt number (tryNb ) and the original delay (retryDelay ) specified in the retryDelay option
|
respectRetryAfter |
|
true |
Whether to respect the delay provided in a retry-after header when receiving a 503 response. True will respect the received delay, false will ignore it and use the retryDelayType and retryDelay options to determine the delay. In any case, the delay is capped by the maxRetryDelay option. |
maxRetryDelay | Positive integer above 0 | 60000 |
Maximum time to wait before retrying, in milliseconds. Overrides Retry-After response-headers (see the respectRetryAfter ) option and normal retry delay increments (see the retryDelay ) option. |
retryOn404 |
|
false |
Whether to retry when response status code is 404. This looks stupid, and most of the time it will be. It is recommended to leave the default in for this one. |
Examples
fs
fs
fs
New methods
fs.remove( path, callback )
Remove a file or directory recursively
Argument | Type | Description |
---|---|---|
path | String | path |
callback | function (err) | Callback |
fs fs
fs.mkdirp( path, [ options ], callback)
Create any necessary subdirectories to allow path to exist. Also see fs.writeFile
's mkdirp option.
Argument | Type | Default | Description |
---|---|---|---|
path | String | path to create | |
options | Mode | 0777 | |
callback | function (err) | Callback |
fs
fs.readJSON( path, [ options ], callback)
Reads a file and JSON.parse
s it
fs
fs.writeJSON( path, data, [ options ], callback)
JSON.stringify
s data and writes the resulting string to path
fs
fs.editJSON( path, fn, [ options ], callback)
Reads the file found at path, JSON.parse
s it, passes the result as a single parameter to fn, JSON.stringify
s whatever fn returns, saves the resulting string to that same file and calls callback.
fs
fn can also return a promise
var Promise = fs
Native only
fs.rootDir
Root directory of the filesystem
console
Supported platforms
platform | support |
---|---|
node | full |
iOS | partial |
Android | partial |
Windows Phone | partial |
other | none |
Supported on native
fs.readFile
fs.writeFile
fs.readdir
fs.mkdir
fs.rmdir
fs.rename
fs.unlink
fs.exists
fs.stat
(Only supports creation date, modification date and accessed date, all of which are Date objects)fs.remove
Internals
vigour-fs
is based ongraceful-fs
fs.mkdirp
and themkdirp
option available onfw.writeFile
andfs.writeJSON
use node-mkdirp) internallyfs.remove
uses rimraf internally
License
ISC