From 5fbc1a0ea18fb7a32248e696bd30505524a43f7e Mon Sep 17 00:00:00 2001 From: Paoda Date: Wed, 20 Feb 2019 13:31:54 -0600 Subject: [PATCH] misc changes and documentation --- src/components/Body/Table.js | 13 +++++++++++-- src/components/Modal.js | 1 + src/melodii/MusicPlayer.js | 2 +- src/melodii/Song.js | 2 +- src/melodii/SongArchive.js | 4 ++-- 5 files changed, 16 insertions(+), 6 deletions(-) diff --git a/src/components/Body/Table.js b/src/components/Body/Table.js index a7dc05d..e103724 100644 --- a/src/components/Body/Table.js +++ b/src/components/Body/Table.js @@ -215,7 +215,6 @@ export async function generate(path, template) { * @return {Object} Table Object with Body Completely parsed. * @async */ - async function generateBody(tableArg, arr, start, end) { let table = tableArg; const t1 = performance.now(); @@ -245,6 +244,12 @@ export async function generate(path, template) { }); } + /** + * Creates a unique ID that is not UUID compliant. + * - used to distinguish table objects from one another. + * @param {Number} length + * @return {String} + */ function createID(length) { const chars = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"; let id; @@ -263,7 +268,11 @@ export async function generate(path, template) { } } - +/** + * Writes JSON to disk usnig ElectronSettings. + * - TODO: Switch to a Database for scalibility. + * @param {JSON} tableJSON + */ export function saveTable(tableJSON) { const stamp = Date.now(); diff --git a/src/components/Modal.js b/src/components/Modal.js index 56cf474..543c960 100644 --- a/src/components/Modal.js +++ b/src/components/Modal.js @@ -19,6 +19,7 @@ export default class Modal extends React.Component { }); } + render() { // Probably should remove once done with debugging if (this.state.style.display === "flex") console.log("Modal Show") diff --git a/src/melodii/MusicPlayer.js b/src/melodii/MusicPlayer.js index 6fdb23a..b377238 100644 --- a/src/melodii/MusicPlayer.js +++ b/src/melodii/MusicPlayer.js @@ -52,7 +52,7 @@ export default class MusicPlayer { try { this.element.src = this.getURICompatible(path); this.element.load(); - console.log(path + " was succesfully loaded"); + console.log("'" + path + "'" + " was succesfully loaded"); } catch (e) { console.error(path + " failed to load: " + e.name); } diff --git a/src/melodii/Song.js b/src/melodii/Song.js index c7a60ae..2dcf7fd 100644 --- a/src/melodii/Song.js +++ b/src/melodii/Song.js @@ -49,7 +49,7 @@ export default class Song { Emitter.emit('updateAlbumArt', noalbumart); } } else { - console.warn(metadata.common.title + ' des not have Album Art'); + console.warn(metadata.common.title + ' does not have Album Art'); Emitter.emit('updateAlbumArt', noalbumart); } } diff --git a/src/melodii/SongArchive.js b/src/melodii/SongArchive.js index 599d919..edbc1ba 100644 --- a/src/melodii/SongArchive.js +++ b/src/melodii/SongArchive.js @@ -2,10 +2,10 @@ import Song from './Song'; import Playlist from './Playlist'; /** @type {Array} */ -var archive = []; +const archive = []; /** @type {Array} */ -let playlists = []; +const playlists = []; /** @type {Song} */ let currentSong;