tidyfs
Objectives
Promisify node's native fs module (see https://nodejs.org/api/fs.html). Improve naming. This is done by adding camel-case for readability and improving consistency.
How to use
Prerequisite
Promises
You should know how to use JS promises. To get started, here's a few helpful links:
- https://developers.google.com/web/fundamentals/getting-started/primers/promises
- https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Promise
Node JS
Overview
The fs module functions are renamed to be more consistent. Summary of changes:
mkdir
--->mkDir
writeFile
--->mkFile
readdir
--->readDir
readFile
--->readFile
rmdir
--->rmDir
unlink
--->rmFile
stat
--->stat
access
--->access
Example usage
Note: all parameters and returning values (passed to promise success) are the same as with the native nodeJS fs module.
Include module
First you should require the module.
var fs = ;
mkDir
Make a directory. Returns a promise.
//Include modulevar fs = ; //Make a directory (folder)fs ;
mkFile
Make a file. Returns a promise.
//Include modulevar fs = ; //Make a (text) file (with 'Hello World' as content)fs ;
readDir
Read a directory. Returns a promise.
//Include modulevar fs = ; //Read dir (folder) contentfs ;
readFile
Read a file. Returns a promise.
//Include modulevar fs = ; //Read a filefs ;
stat
Get information on an item (file or directory). Returns a promise.
//Include modulevar fs = ; //Get information on a filefs ; //Get information on a directoryfs ;
access
Returns an error if file does not exists, otherwise a resolved promise. For rwx permission check see nodeJS docs.
//Include modulevar fs = ; fs ; fs ;
rmDir
Remove a directory. Returns a promise.
//Include modulevar fs = ; //Remove 'hello' directoryfs ;
rmFile
Remove a file. Returns a promise.
//Include modulevar fs = ; //Remove a filefs ;