update jsdoc and other deps (#3896)

other cosmetic code changes because of new `eslint-plugin-jsdoc` version
v60

Author: khassel

CHANGELOG.md

@@ -45,7 +45,7 @@ Thanks to: @dathbe.
 ### Updated
 
 - [calendar] Update defaultSymbol name and also the link to the icon search site (#3879)
-- [core] Update dependencies including electron to v38 as well as github actions (#3831, #3849, #3857, #3858, #3872, #3876, #3882, #3891)
+- [core] Update dependencies including electron to v38 as well as github actions (#3831, #3849, #3857, #3858, #3872, #3876, #3882, #3891, #3896)
 - [weather] Update feels_like temperature calculation formula (#3869)
 - [weather] Update null value handling for weather type (#3892)
 - [layout] Update styles for weather and calendar (#3894)

js/main.js

@@ -90,7 +90,7 @@ const MM = (function () {
 	/**
 	 * Send a notification to all modules.
 	 * @param {string} notification The identifier of the notification.
-	 * @param {*} payload The payload of the notification.
+	 * @param {object} payload The payload of the notification.
 	 * @param {Module} sender The module that sent the notification.
 	 * @param {Module} [sendTo] The (optional) module to send the notification to.
 	 */
@@ -262,7 +262,7 @@ const MM = (function () {
 	 * Hide the module.
 	 * @param {Module} module The module to hide.
 	 * @param {number} speed The speed of the hide animation.
-	 * @param {Function} callback Called when the animation is done.
+	 * @param {Promise} callback Called when the animation is done.
 	 * @param {object} [options] Optional settings for the hide method.
 	 */
 	const hideModule = function (module, speed, callback, options = {}) {
@@ -347,7 +347,7 @@ const MM = (function () {
 	 * Show the module.
 	 * @param {Module} module The module to show.
 	 * @param {number} speed The speed of the show animation.
-	 * @param {Function} callback Called when the animation is done.
+	 * @param {Promise} callback Called when the animation is done.
 	 * @param {object} [options] Optional settings for the show method.
 	 */
 	const showModule = function (module, speed, callback, options = {}) {
@@ -552,7 +552,7 @@ const MM = (function () {
 
 		/**
 		 * Walks thru a collection of modules and executes the callback with the module as an argument.
-		 * @param {Function} callback The function to execute with the module as an argument.
+		 * @param {module} callback The function to execute with the module as an argument.
 		 */
 		const enumerate = function (callback) {
 			modules.map(function (module) {
@@ -629,7 +629,7 @@ const MM = (function () {
 		/**
 		 * Send a notification to all modules.
 		 * @param {string} notification The identifier of the notification.
-		 * @param {*} payload The payload of the notification.
+		 * @param {object} payload The payload of the notification.
 		 * @param {Module} sender The module that sent the notification.
 		 */
 		sendNotification (notification, payload, sender) {
@@ -688,7 +688,7 @@ const MM = (function () {
 		 * Hide the module.
 		 * @param {Module} module The module to hide.
 		 * @param {number} speed The speed of the hide animation.
-		 * @param {Function} callback Called when the animation is done.
+		 * @param {Promise} callback Called when the animation is done.
 		 * @param {object} [options] Optional settings for the hide method.
 		 */
 		hideModule (module, speed, callback, options) {
@@ -700,7 +700,7 @@ const MM = (function () {
 		 * Show the module.
 		 * @param {Module} module The module to show.
 		 * @param {number} speed The speed of the show animation.
-		 * @param {Function} callback Called when the animation is done.
+		 * @param {Promise} callback Called when the animation is done.
 		 * @param {object} [options] Optional settings for the show method.
 		 */
 		showModule (module, speed, callback, options) {

js/module.js

@@ -68,7 +68,7 @@ const Module = Class.extend({
 	 * Returns a map of translation files the module requires to be loaded.
 	 *
 	 * return Map<String, String> -
-	 * @returns {*} A map with langKeys and filenames.
+	 * @returns {Map} A map with langKeys and filenames.
 	 */
 	getTranslations () {
 		return false;
@@ -140,7 +140,7 @@ const Module = Class.extend({
 	/**
 	 * Called by the MagicMirror² core when a notification arrives.
 	 * @param {string} notification The identifier of the notification.
-	 * @param {*} payload The payload of the notification.
+	 * @param {object} payload The payload of the notification.
 	 * @param {Module} sender The module that sent the notification.
 	 */
 	notificationReceived (notification, payload, sender) {
@@ -176,7 +176,7 @@ const Module = Class.extend({
 	/**
 	 * Called when a socket notification arrives.
 	 * @param {string} notification The identifier of the notification.
-	 * @param {*} payload The payload of the notification.
+	 * @param {object} payload The payload of the notification.
 	 */
 	socketNotificationReceived (notification, payload) {
 		Log.log(`${this.name} received a socket notification: ${notification} - Payload: ${payload}`);
@@ -344,7 +344,7 @@ const Module = Class.extend({
 	/**
 	 * Send a notification to all modules.
 	 * @param {string} notification The identifier of the notification.
-	 * @param {*} payload The payload of the notification.
+	 * @param {object} payload The payload of the notification.
 	 */
 	sendNotification (notification, payload) {
 		MM.sendNotification(notification, payload, this);
@@ -353,7 +353,7 @@ const Module = Class.extend({
 	/**
 	 * Send a socket notification to the node helper.
 	 * @param {string} notification The identifier of the notification.
-	 * @param {*} payload The payload of the notification.
+	 * @param {object} payload The payload of the notification.
 	 */
 	sendSocketNotification (notification, payload) {
 		this.socket().sendNotification(notification, payload);
@@ -362,7 +362,7 @@ const Module = Class.extend({
 	/**
 	 * Hide this module.
 	 * @param {number} speed The speed of the hide animation.
-	 * @param {Function} callback Called when the animation is done.
+	 * @param {Promise} callback Called when the animation is done.
 	 * @param {object} [options] Optional settings for the hide method.
 	 */
 	hide (speed, callback, options = {}) {
@@ -389,7 +389,7 @@ const Module = Class.extend({
 	/**
 	 * Show this module.
 	 * @param {number} speed The speed of the show animation.
-	 * @param {Function} callback Called when the animation is done.
+	 * @param {Promise} callback Called when the animation is done.
 	 * @param {object} [options] Optional settings for the show method.
 	 */
 	show (speed, callback, options) {

js/module_functions.js

@@ -2,7 +2,7 @@
  * Schedule the timer for the next update
  * @param {object} timer The timer of the module
  * @param {bigint} intervalMS interval in milliseconds
- * @param {Function} callback function to call when the timer expires
+ * @param {Promise} callback function to call when the timer expires
  */
 const scheduleTimer = function (timer, intervalMS, callback) {
 	if (process.env.JEST_WORKER_ID === undefined) {

js/node_helper.js

@@ -27,7 +27,7 @@ const NodeHelper = Class.extend({
 	/**
 	 * This method is called when a socket notification arrives.
 	 * @param {string} notification The identifier of the notification.
-	 * @param {*}  payload The payload of the notification.
+	 * @param {object}  payload The payload of the notification.
 	 */
 	socketNotificationReceived (notification, payload) {
 		Log.log(`${this.name} received a socket notification: ${notification} - Payload: ${payload}`);

modules/default/calendar/calendar.js

@@ -876,7 +876,7 @@ Module.register("calendar", {
 	 * @param {string} url The calendar url
 	 * @param {string} property The property to look for
 	 * @param {string} defaultValue The value if the property is not found
-	 * @returns {*} The property
+	 * @returns {property} The property
 	 */
 	getCalendarProperty (url, property, defaultValue) {
 		for (const calendar of this.config.calendars) {

modules/default/calendar/calendarfetcher.js

@@ -97,15 +97,15 @@ const CalendarFetcher = function (url, reloadInterval, excludedEvents, maximumEn
 
 	/**
 	 * Sets the on success callback
-	 * @param {Function} callback The on success callback.
+	 * @param {eventsReceivedCallback} callback The on success callback.
 	 */
 	this.onReceive = function (callback) {
 		eventsReceivedCallback = callback;
 	};
 
 	/**
 	 * Sets the on error callback
-	 * @param {Function} callback The on error callback.
+	 * @param {fetchFailedCallback} callback The on error callback.
 	 */
 	this.onError = function (callback) {
 		fetchFailedCallback = callback;

modules/default/newsfeed/newsfeed.js

@@ -181,7 +181,7 @@ Module.register("newsfeed", {
 	 * Gets a feed property by name
 	 * @param {object} feed A feed object.
 	 * @param {string} property The name of the property.
-	 * @returns {*} The value of the specified property for the feed.
+	 * @returns {property} The value of the specified property for the feed.
 	 */
 	getFeedProperty (feed, property) {
 		let res = this.config[property];

modules/default/weather/providers/smhi.js

@@ -254,7 +254,7 @@ WeatherProvider.register("smhi", {
 	 * Helper method to get a property from the returned data set.
 	 * @param {object} currentWeatherData Weatherdata to get from
 	 * @param {string} name The name of the property
-	 * @returns {*} The value of the property in the weatherdata
+	 * @returns {string} The value of the property in the weatherdata
 	 */
 	paramValue (currentWeatherData, name) {
 		return currentWeatherData.parameters.filter((p) => p.name === name).flatMap((p) => p.values)[0];