if/SymphonyElectron
1
0
Fork 0
mirror of https://github.com/finos/SymphonyElectron.git synced 2024-12-28 09:51:06 -06:00
Code Issues Packages Projects Releases Wiki Activity

ELECTRON-113: added documentation

Browse Source
This commit is contained in:
Vishwas Shashidhar 2017-09-01 13:56:02 +05:30 committed by Vishwas Shashidhar
parent 526c7cc1c9
commit 5e67987696
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
js/config.js
View File

@ -44,6 +44,11 @@ function getConfigField(fieldName) {
});
}
/**
* Gets a specific user config value for a field
* @param fieldName
* @returns {Promise}
*/
function getUserConfigField(fieldName) {
return readUserConfig().then(function(config) {
if (typeof fieldName === 'string' && fieldName in config) {
@ -54,6 +59,11 @@ function getUserConfigField(fieldName) {
});
}
/**
* Reads the user config file and returns all the attributes
* @param customConfigPath
* @returns {Promise}
*/
function readUserConfig(customConfigPath) {
return new Promise(function(resolve, reject) {
if (userConfig) {
@ -84,6 +94,11 @@ function readUserConfig(customConfigPath) {
});
}
/**
* Gets a specific user config value for a field
* @param fieldName
* @returns {Promise}
*/
function getGlobalConfigField(fieldName) {
return readGlobalConfig().then(function(config) {
if (typeof fieldName === 'string' && fieldName in config) {
@ -165,6 +180,13 @@ function updateConfigField(fieldName, newValue) {
});
}
/**
* Saves an updated value to the user config
* @param fieldName
* @param newValue
* @param oldConfig
* @returns {Promise}
*/
function saveUserConfig(fieldName, newValue, oldConfig) {
return new Promise(function(resolve, reject) {
let configPath = path.join(app.getPath('userData'), configFileName);
@ -318,6 +340,9 @@ function copyConfigMac(globalConfigPath) {
});
}
/**
* Clears the cached config
*/
function clearCachedConfigs() {
userConfig = null;
globalConfig = null;