ls-fs v1.2.1

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

1. path (String) The path to the JSON file to read

writeJson

lsFs.writeJson(path, obj, [opts]).then(function(pathToJson) {
    
});

Arguments

1. path (String) The path to the JSON file to write
2. obj (*) The thing to JSON.stringify

readIni

lsFs.readIni(path, [opts]).then(function(parsedIniObj) {
    console.log(parsedIniObj);
});

Arguments

1. path (String) The path to the INI file to read
2. [opts] (Object) Identical to q-io/fs.read options

writeIni

lsFs.writeIni(path, obj, [opts]).then(function(pathToIni) {
    console.log('wrote ' + pathToIni);
});

Arguments

1. path (String) The path to the INI file to write
2. obj (*) The thing to stringify into INI format
3. opts (Object) Merge of options for ini and q-io/fs.write

tmpDir

lsFs.tmpDir([opts]).then(function(pathToTmpDir) {
    // do stuff with my temporary directory
});

Arguments

1. [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 required 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

1. pathToDir (String) Path to the directory you would like to recursively require