tyler.durden
/
dashy
mirror of https://github.com/Lissy93/dashy.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

📝 Adds in-code docs to config accumalator

This commit is contained in:
Alicia Sykes 2021-06-20 20:42:37 +01:00
parent 20e12fecb9
commit 04708a4f3f
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/utils/ConfigAccumalator.js
View File

@ -2,11 +2,14 @@
* Reads the users config from `conf.yml`, and combines it with any local preferences * Reads the users config from `conf.yml`, and combines it with any local preferences
* Also ensures that any missing attributes are populated with defaults, and the * Also ensures that any missing attributes are populated with defaults, and the
* object is structurally sound, to avoid any error if the user is missing something * object is structurally sound, to avoid any error if the user is missing something
* The main config object is make up of three parts: appConfig, pageInfo and sections * The main config object is made up of three parts: appConfig, pageInfo and sections
*/ */
import Defaults, { localStorageKeys } from '@/utils/defaults'; import Defaults, { localStorageKeys } from '@/utils/defaults';
import conf from '../../public/conf.yml'; import conf from '../../public/conf.yml';
/**
* Returns the appConfig section, as JSON
*/
export const appConfig = (() => { export const appConfig = (() => {
let usersAppConfig = Defaults.appConfig; let usersAppConfig = Defaults.appConfig;
if (localStorage[localStorageKeys.APP_CONFIG]) { if (localStorage[localStorageKeys.APP_CONFIG]) {
@ -21,6 +24,9 @@ export const appConfig = (() => {
return usersAppConfig; return usersAppConfig;
})(); })();
/**
* Returns the pageInfo section, as JSON
*/
export const pageInfo = (() => { export const pageInfo = (() => {
const defaults = Defaults.pageInfo; const defaults = Defaults.pageInfo;
let localPageInfo; let localPageInfo;
@ -37,6 +43,9 @@ export const pageInfo = (() => {
return pi; return pi;
})(); })();
/**
* Returns the sections section, as an array of JSON objects
*/
export const sections = (() => { export const sections = (() => {
// If the user has stored sections in local storage, return those // If the user has stored sections in local storage, return those
const localSections = localStorage[localStorageKeys.CONF_SECTIONS]; const localSections = localStorage[localStorageKeys.CONF_SECTIONS];
@ -52,6 +61,9 @@ export const sections = (() => {
return conf.sections; return conf.sections;
})(); })();
/**
* Returns the complete configuration, as JSON
*/
export const config = (() => { export const config = (() => {
const result = { const result = {
appConfig, appConfig,