move toggleFullScreen to DOM and only export getDate from getDate file

201flaviosilva · Oct 14, 2022 · 2c0e9f8 · 2c0e9f8
1 parent b13f0ee
commit 2c0e9f8
Show file tree

Hide file tree

Showing 5 changed files with 45 additions and 5 deletions.
diff --git a/jsdoc.conf.json b/jsdoc.conf.json
@@ -26,7 +26,7 @@
       "menu": [
         {
           "title": "GitHub",
-          "link": "https://github.com/201flaviosilva/javascript-utils/",
+          "link": "https://github.com/201flaviosilva-labs/javascript-utils/",
           "target": "_blank"
         }
       ]

diff --git a/src/DOM/index.js b/src/DOM/index.js
@@ -4,6 +4,7 @@ import { KeyboardManager, KeyboardManagerInstance, KEYS } from "./KeyboardManage
 import { MouseManager, MouseManagerInstance, MouseButton } from "./MouseManager.js";
 import { notification } from "./notification.js";
 import { printObjectInDOM } from "./printObjectInDOM.js";
+import { toggleFullScreen } from "./toggleFullScreen.js";
 
 /**
  * Utils for DOM
@@ -16,4 +17,5 @@ export {
 	MouseManager, MouseManagerInstance, MouseButton,
 	notification,
 	printObjectInDOM,
+	toggleFullScreen,
 };
diff --git a/src/toggleFullScreen.js → src/DOM/toggleFullScreen.js b/src/toggleFullScreen.js → src/DOM/toggleFullScreen.js
@@ -7,6 +7,9 @@
  * 
  * @param {HTMLElement} element - the DOM element to put in full screen
  * @returns {void}
+ * 
+ * @function toggleFullScreen
+ * @memberof DOM
  */
 export function toggleFullScreen(element = document.documentElement) {
 	if (!document.fullscreenElement) element.requestFullscreen();

diff --git a/src/getDate.js b/src/getDate.js
@@ -1,3 +1,40 @@
+/**
+ * Returns the date
+ * @see {@link https://www.w3schools.com/jsref/jsref_obj_date.asp}
+ * 
+ * @example
+ * getDate() // {
+		time: 1653573577063,
+		milliseconds: 134,
+		seconds: 24,
+		minutes: 24,
+		hours: 15,
+		day: 31,
+		weekDay: 7,
+		week: 50,
+		month: 5,
+		year: 2022,
+		dateFormatted: "1/1/2021",
+	}
+ * 
+ * @returns {Object}
+ */
+export function getDate() {
+	return {
+		time: getTime(),
+		milliseconds: getMilliseconds(),
+		seconds: getSeconds(),
+		minutes: getMinutes(),
+		hours: getHours(),
+		day: getDay(),
+		weekDay: getWeekDay(),
+		week: getWeek(),
+		month: getMonth(),
+		year: getYear(),
+		dateFormatted: getDateFormatted(),
+	}
+}
+
 /**
  * Returns the number of milliseconds since midnight Jan 1 1970, and a specified date
  * @see {@link https://www.w3schools.com/jsref/jsref_obj_date.asp}

diff --git a/src/index.js b/src/index.js
@@ -30,7 +30,7 @@ import { divideEvenly } from "./divideEvenly.js";
 import { EventSystem, EventSystemInstance } from "./EventSystem.js";
 import { Fibonacci, fibonacciSequence, fibonacciUntil, fibonacciCustomSequence, recursiveFibonacci } from "./Fibonacci.js";
 import { FIFO } from "./FIFO.js";
-import { getTime, getMilliseconds, getSeconds, getMinutes, getHours, getDay, getWeekDay, getWeek, getMonth, getYear, getDateFormatted } from "./getDate.js";
+import { getDate } from "./getDate.js"; // import { getTime, getMilliseconds, getSeconds, getMinutes, getHours, getDay, getWeekDay, getWeek, getMonth, getYear, getDateFormatted } from "./getDate.js";
 import { getPositionWithAngleDistance } from "./getPositionWithAngleDistance.js";
 import { getUrlParameter } from "./getUrlParameter.js";
 import { getVersion } from "./getVersion.js";
@@ -62,7 +62,6 @@ import { stringToScreamingSnakeCase, screamingSnakeCaseToNormal } from "./scream
 import { stringToSnakeCase, snakeCaseToNormal } from "./snakeCase.js";
 import { subtraction } from "./subtraction.js";
 import { sum } from "./sum.js";
-import { toggleFullScreen } from "./toggleFullScreen.js";
 import { topDownCarMovimentation } from "./topDownCarMovimentation.js";
 import { Vector2 } from "./Vector2.js";
 import { xnor } from "./xnor.js";
@@ -99,7 +98,7 @@ export {
 	EventSystem, EventSystemInstance,
 	Fibonacci, fibonacciSequence, fibonacciUntil, fibonacciCustomSequence, recursiveFibonacci,
 	FIFO,
-	getTime, getMilliseconds, getSeconds, getMinutes, getHours, getDay, getWeekDay, getWeek, getMonth, getYear, getDateFormatted,
+	getDate, // getTime, getMilliseconds, getSeconds, getMinutes, getHours, getDay, getWeekDay, getWeek, getMonth, getYear, getDateFormatted,
 	getPositionWithAngleDistance,
 	getUrlParameter,
 	getVersion,
@@ -131,7 +130,6 @@ export {
 	stringToSnakeCase, snakeCaseToNormal,
 	subtraction,
 	sum,
-	toggleFullScreen,
 	topDownCarMovimentation,
 	Vector2,
 	xnor,