chore: add basic docs

qlik-oss · Oct 20, 2022 · 657455e · 657455e
1 parent 3033721
commit 657455e
Showing 1 changed file with 12 additions and 1 deletion.
diff --git a/apis/theme/src/index.js b/apis/theme/src/index.js
@@ -100,7 +100,18 @@ export default function theme() {
 
       return styleResolverInstanceCache[basePath].getStyle(path, attribute);
     },
-
+    /**
+     * Validates a color string using d3-color.
+     * See https://www.npmjs.com/package/d3-color
+     * @param {string} specifier
+     * @returns {string|undefined} The resolved color or undefined
+     * @ignore
+     *
+     * @example
+     * theme.validateColor("red"); // returns "rgba(255,0,0,1)"
+     * theme.validateColor("#00ff00"); // returns "rgba(0,255,0,1)"
+     * theme.validateColor("FOO"); // returns undefined
+     */
     validateColor(...args) {
       const c = d3color(...args);
       return c ? c.toString() : undefined;