From 4c45d56344ae06bc5368e20980a257fe0de6acd0 Mon Sep 17 00:00:00 2001
From: Tolfx <matteus@tolfx.dev>
Date: Tue, 11 Oct 2022 21:55:18 +0200
Subject: [PATCH] feat: time jsdocs (#76)

---
 packages/lib/src/Time.ts | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/packages/lib/src/Time.ts b/packages/lib/src/Time.ts
index 9b54bbe..e7f1726 100644
--- a/packages/lib/src/Time.ts
+++ b/packages/lib/src/Time.ts
@@ -1,11 +1,20 @@
 import dateFormat from "date-and-time";
 
 
+/**
+ * 
+ * @param date 
+ * @param format 
+ * @returns A string formatted date based on format
+ */
 export function formatDate(date: Date, format: string): string
 {
     return dateFormat.format(date, format);
 }
 
+/**
+ * @returns Date format YYYY-MM-DD HH:mm:ss
+ */
 export function getTime() 
 {
     const D_CurrentDate = new Date();
@@ -13,6 +22,11 @@ export function getTime()
     return dateFormat.format(D_CurrentDate, "YYYY-MM-DD HH:mm:ss");
 }
 
+/**
+ * 
+ * @param removeDays Removes days from current date
+ * @returns Returns date format YYYY-MM-DD or YYYY-MM
+ */
 export function getDate(removeDays = false)
 {
     const D_CurrentDate = new Date();