added jsDocs

do0dleman · May 21, 2023 · 1a6187c · 1a6187c
1 parent f3350b4
commit 1a6187c
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "do0dle-colors",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "a library to generate color schemes.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

diff --git a/src/utils/convert/hslToRgb.ts b/src/utils/convert/hslToRgb.ts
@@ -1,7 +1,11 @@
 import hsl from "../../types/hslType";
 import rgb from "../../types/rgbType";
 
-
+/**
+ * Converts hsl color to rgb color
+ * @param {hsl} hsl hsl color value represented by an array 
+ * @returns {rgb}   rgb color value represented by an array
+ */
 export default function hslToRgb(hsl: hsl): rgb {
 
     let [H, S, L] = hsl