chore: improve comments in utils

Author: mekwall

src/utils/parseBitrate.ts

@@ -1,4 +1,11 @@
-// Converts input bitrate to kbits/s
+/**
+ * Converts the given bitrate value to kilobits per second (kbps) based on the provided unit.
+ *
+ * @param bitrate The bitrate value to be converted.
+ * @param unit The unit of the given bitrate value. Supported units are "b/s", "bit/s", "bits/s", "kb/s", "kbit/s", "kbits/s", "mb/s", "mbit/s", and "mbits/s".
+ * @returns The bitrate value converted to kbps.
+ * @throws Error if the provided unit is not recognized.
+ */
 export function parseBitrate(bitrate: number, unit: string): number {
   switch (unit.toLowerCase()) {
     case "b/s":

src/utils/parseSize.ts

@@ -1,4 +1,11 @@
-// Converts input size to bytes
+/**
+ * Parses a size value with a unit and returns the size in bytes.
+ *
+ * @param size - The size value to parse.
+ * @param unit - The unit of the size value, e.g. "B", "KB", "MB".
+ * @returns The size in bytes.
+ * @throws {Error} If the unit is unknown.
+ */
 export function parseSize(size: number, unit: string): number {
   switch (unit.toLowerCase()) {
     case "b":

src/utils/secsToTimer.ts

@@ -1,4 +1,9 @@
-// Convert seconds to HH:MM:SS.MS
+/**
+ * Converts a number of seconds to a formatted timer string in the format "HH:MM:SS.MS".
+ *
+ * @param seconds - The number of seconds to convert.
+ * @returns A formatted timer string.
+ */
 export function secsToTimer(seconds: number): string {
   const h = Math.floor(seconds / 3600);
   const m = Math.floor(seconds / 60) % 60;

src/utils/timerToSecs.ts

@@ -1,4 +1,9 @@
-// Convert HH:MM:SS.MS to seconds
+/**
+ * Converts a time string in the format "HH:MM:SS.MS" to a number of seconds.
+ *
+ * @param input - A time string in the format "HH:MM:SS.MS".
+ * @returns The number of seconds represented by the input time string, rounded to two decimal places.
+ */
 export function timerToSecs(input: string): number {
   const timer = input.split(":");
   const hours = +timer[0];