From 1d62e859257529aeddc9a0a37c95b2aae79e2ce8 Mon Sep 17 00:00:00 2001
From: Histmy <Histmytv@seznam.cz>
Date: Sun, 7 Nov 2021 13:48:50 +0100
Subject: [PATCH] added docs to some functions in utils.ts

---
 src/utils/utils.ts | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/src/utils/utils.ts b/src/utils/utils.ts
index 11bc4b1..b303987 100644
--- a/src/utils/utils.ts
+++ b/src/utils/utils.ts
@@ -51,6 +51,10 @@ export const oddiakritikovat = (a: string) => {
     .replace(/[ŹŻŽ]/g, "Z");
 };
 
+/**
+ * returns relative time in format `x hodin x minut a x se kund`
+ * @param cas Number of seconds to convert
+ */
 export const formatCas = (cas: number) => {
   const h = Math.floor(cas / 3600);
   const m = Math.floor(cas % 3600 / 60);
@@ -165,6 +169,10 @@ export function loadEnv() {
   process.env = { ...process.env, ...require("../../config.json") };
 }
 
-export const formatter = new Intl.DateTimeFormat("cs", { day: "numeric", month: "short", hour: "numeric", minute: "numeric", second: "numeric" });
+/**
+ * Returns absolute date in format `d. m. h:mm:ss`
+ * @param date Date object to convert
+ */
+export const formatter = new Intl.DateTimeFormat("cs", { day: "numeric", month: "short", hour: "numeric", minute: "numeric", second: "numeric" }).format;
 
 export const ping = /^<@!?\d+>$/;