@trackunit/css-tailwind-custom-properties-plugin 0.0.10 → 0.0.12

package/index.cjs

@@ -12,7 +12,7 @@ var plugin__default = /*#__PURE__*/_interopDefaultLegacy(plugin);
  * Converts an array of keys to a valid CSS custom property name.
  *
  * @param keys An array of strings representing the keys to be converted to a CSS custom property name.
- * @returns A string representing the CSS custom property name.
+ * @returns { string } A string representing the CSS custom property name.
  */
 const keysToCssVariableName = (keys) => `--${keys.join("-")}`.replace(/[^a-zA-Z0-9]/g, "-");
 /**
@@ -23,7 +23,7 @@ const keysToCssVariableName = (keys) => `--${keys.join("-")}`.replace(/[^a-zA-Z0
  * @param {object} values - The object containing the nested variables declarations and their values
  * @param {object} [output] - The flat object to store the generated CSS variable names and values
  * @param {string[]} [keys] - An array of keys representing the current path of the object being processed
- * @returns {object} - The generated flat object containing the CSS variable names and values
+ * @returns {VariablesDeclerationObject} - The generated flat object containing the CSS variable names and values
  */
 const flattenVariablesDeclerationValues = (values, output = {}, keys = []) => {
     for (const [key, value] of Object.entries(values)) {
@@ -42,7 +42,7 @@ const flattenVariablesDeclerationValues = (values, output = {}, keys = []) => {
  * Converts a object containing CSS variables to an array of CSS rules.
  *
  * @param variablesDecleration An object containing the CSS variables and their corresponding values.
- * @returns An array of CSS rules.
+ * @returns {CSSRuleObject[]} An array of CSS rules.
  */
 const variablesToCSSRules = (variablesDecleration) => {
     if (!variablesDecleration) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/css-tailwind-custom-properties-plugin",
-  "version": "0.0.10",
+  "version": "0.0.12",
   "main": "./index.cjs",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",

package/src/variablesToCSSRules.d.ts

@@ -6,7 +6,7 @@ export type VariablesDeclerationObject = {
  * Converts an array of keys to a valid CSS custom property name.
  *
  * @param keys An array of strings representing the keys to be converted to a CSS custom property name.
- * @returns A string representing the CSS custom property name.
+ * @returns { string } A string representing the CSS custom property name.
  */
 export declare const keysToCssVariableName: (keys: string[]) => string;
 /**
@@ -17,13 +17,13 @@ export declare const keysToCssVariableName: (keys: string[]) => string;
  * @param {object} values - The object containing the nested variables declarations and their values
  * @param {object} [output] - The flat object to store the generated CSS variable names and values
  * @param {string[]} [keys] - An array of keys representing the current path of the object being processed
- * @returns {object} - The generated flat object containing the CSS variable names and values
+ * @returns {VariablesDeclerationObject} - The generated flat object containing the CSS variable names and values
  */
 export declare const flattenVariablesDeclerationValues: (values: object, output?: VariablesDeclerationObject, keys?: string[]) => VariablesDeclerationObject;
 /**
  * Converts a object containing CSS variables to an array of CSS rules.
  *
  * @param variablesDecleration An object containing the CSS variables and their corresponding values.
- * @returns An array of CSS rules.
+ * @returns {CSSRuleObject[]} An array of CSS rules.
  */
 export declare const variablesToCSSRules: (variablesDecleration: object) => CSSRuleObject[];