cfgread v1.1.4

CFGRead ( 1.1.4 )

This is a module for easily generating configuration files. Currently there are two supported formats, one I call "simple", the other is JSON. Besides generating configuration files, this module can also read configuration files.

Functions

format : Object

Kind: global variable

Example

format.SIMPLE
format.JSON

checkConfigFile(path) ⇒ boolean

Kind: global function

Returns: boolean - Returns true if the given configuration file exists, false if not.

setFormat(format)

Kind: global function

Throws: Throws when an invalid format has been given.

generateConfigFile(path, variables)

Generates a configuration file with a given set of variables. If no arguments are given, a default configuration file will be generated, which is empty.

Kind: global function

Example

// Creates a file with the following content:
//	name1=value1
// 	name2=value2
//	name3=
let cfgread = require('cfgread');
cfgread.generateConfigFile("./config.cfg", ["name1", "value1"], ["name2", "value2"], "name3");

setConfigFile(path)

Kind: global function

Throws: Throws when an invalid string has been given.

readConfigFile(path) ⇒ Object

Kind: global function

Returns: Object - Returns an object with the contents of the configuration file.

Throws: Throws when an invalid path has been given.

Example

// Output: { name1: 'value1', name2: 'value2', name3: NaN }
cfgread.generateConfigFile("./config.cfg", ["name1", "value1"], ["name2", "value2"], "name3");
let output = cfgread.readConfigFile("./config.cfg");
console.log(output);