kenmirrors/MagicMirror
1
0
Fork 0
mirror of https://github.com/MichMich/MagicMirror.git synced 2025-08-21 04:45:17 +00:00
Code Issues Projects Releases Wiki Activity

Refactor formatTime into util class (#3073)

Browse Source 
While looking at https://github.com/MichMich/MagicMirror/pull/3070 I
noticed that the weather and clock module do some formatTime stuff, so
why not use a common function for that?

---------

Co-authored-by: veeck <michael@veeck.de>
This commit is contained in:
Veeck
2023-04-07 23:11:54 +02:00
committed by GitHub
parent 2c7beeaaaf
commit 32192d1698
8 changed files with 129 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
modules/default/clock/clock.js
View File

@@ -1,4 +1,4 @@
/* global SunCalc */
/* global SunCalc, formatTime */
/* MagicMirror²
* Module: Clock
@@ -169,21 +169,6 @@ Module.register("clock", {
digitalWrapper.appendChild(timeWrapper);
}
/**
* Format the time according to the config
*
* @param {object} config The config of the module
* @param {object} time time to format
* @returns {string} The formatted time string
*/
function formatTime(config, time) {
let formatString = `${hourSymbol}:mm`;
if (config.showPeriod && config.timeFormat !== 24) {
formatString += config.showPeriodUpper ? "A" : "a";
}
return moment(time).format(formatString);
}
/****************************************************************
* Create wrappers for Sun Times, only if specified in config
*/

32
modules/default/utils.js
View File

@@ -141,7 +141,37 @@ const getHeadersFromResponse = (expectedResponseHeaders, response) => {
return responseHeaders;
};
/**
* Format the time according to the config
*
* @param {object} config The config of the module
* @param {object} time time to format
* @returns {string} The formatted time string
*/
const formatTime = (config, time) => {
let date = moment(time);
if (config.timezone) {
date = moment.tz(config.timezone);
}
if (config.timeFormat !== 24) {
if (config.showPeriod) {
if (config.showPeriodUpper) {
return date.format("h:mm A");
} else {
return date.format("h:mm a");
}
} else {
return date.format("h:mm");
}
}
return date.format("HH:mm");
};
if (typeof module !== "undefined")
module.exports = {
performWebRequest
performWebRequest,
formatTime
};

18
modules/default/weather/weather.js
View File

@@ -1,4 +1,4 @@
/* global WeatherProvider, WeatherUtils */
/* global WeatherProvider, WeatherUtils, formatTime */
/* MagicMirror²
* Module: Weather
@@ -211,21 +211,7 @@ Module.register("weather", {
this.nunjucksEnvironment().addFilter(
"formatTime",
function (date) {
date = moment(date);
if (this.config.timeFormat !== 24) {
if (this.config.showPeriod) {
if (this.config.showPeriodUpper) {
return date.format("h:mm A");
} else {
return date.format("h:mm a");
}
} else {
return date.format("h:mm");
}
}
return date.format("HH:mm");
return formatTime(this.config, date);
}.bind(this)
);