Methods
generate_password_block()
- Source:
load_configuration(cpath, if_module_top) → {object}
Load the configuration. Called by load_parameters.
It is absolutely required that there be a configuration file for any application using this module.
Pleases refer to documentation referened in the readme.md file for a description of the configuration file.
Parameters:
| Name | Type | Description |
|---|---|---|
cpath |
string | |
if_module_top |
boolean |
- Source:
Returns:
if successful, the configuration object made from reading and parsing the file
- Type
- object
load_parameters(config, if_module_top) → {object}
Parameters:
| Name | Type | Description |
|---|---|---|
config |
object | |
if_module_top |
boolean |
- Source:
Returns:
- the updated configuration object
- Type
- object
module_top(caller_dir) → {string}
Parameters:
| Name | Type | Description |
|---|---|---|
caller_dir |
caller_dir | undefined |
- Source:
Returns:
- the directory from which the mod path modules will be loaded.
- Type
- string