ls-fs
v1.2.1
Published
Some file utilities
Downloads
5
Readme
ls-fs
File utils
Usage
var lsFs = require('ls-fs');
lsFs.readJson('settings.json').then(function(settings) {
console.log(settings.prop1);
console.log(settings.prop2);
});
API
readJson
lsFs.readJson(path, [opts]).then(function(parsedJsonObj) {
console.log(parsedJsonObj);
});
Arguments
path
(String) The path to the JSON file to read
writeJson
lsFs.writeJson(path, obj, [opts]).then(function(pathToJson) {
});
Arguments
path
(String) The path to the JSON file to writeobj
(*) The thing to JSON.stringify
readIni
lsFs.readIni(path, [opts]).then(function(parsedIniObj) {
console.log(parsedIniObj);
});
Arguments
path
(String) The path to the INI file to read[opts]
(Object) Identical toq-io/fs.read
options
writeIni
lsFs.writeIni(path, obj, [opts]).then(function(pathToIni) {
console.log('wrote ' + pathToIni);
});
Arguments
path
(String) The path to the INI file to writeobj
(*) The thing to stringify into INI formatopts
(Object) Merge of options forini
andq-io/fs.write
tmpDir
lsFs.tmpDir([opts]).then(function(pathToTmpDir) {
// do stuff with my temporary directory
});
Arguments
[opts]
(Object) Same as https://github.com/raszi/node-tmp#directory-creation
requireDir
Takes a path to a directory and returns an object containing all the require
d modules in that directory.
For example, if you have a directory with:
some-module.js
other-module.js
static-content.json
requireDir
on that directory would return an object like:
{
someModule: <module.exports of some-module.js>,
...
}
Usage
lsFs.requireDir(pathToDir).then(function(requiredDirObj) {
// use required modules
});
Arguments
pathToDir
(String) Path to the directory you would like to recursively require