[READ-ONLY] Mirror of https://github.com/hacknug/tailwindcss-plugin-utils. A bunch of utilities to help you create and maintain plugins for Tailwind.
www.npmjs.com/package/@hacknug/tailwindcss-plugin-utils
Improve JSDoc comments
Nestor Vera
(Aug 22, 2019, 6:33 PM +0200)
7f66b4ec
4c7f66e8
+12
-7
+12
-7
src/index.js
+12
-7
src/index.js
···
11
11
12
12
/**
13
13
* handleName()
14
+
*
14
15
* @param {string} className
15
16
* @param {string} base
16
17
*/
···
28
29
29
30
/**
30
31
* buildConfig()
31
-
* @param {*} defaultValues
32
-
* @param {*} coreUtils
33
-
* @param {*} themeKey
34
-
* @param {...any} fallbackKeys
32
+
*
33
+
* @param {Object} tailwindConfig
34
+
* @param {Object} coreUtils
35
+
* @param {string} themeKey
36
+
* @param {...string} fallbackKeys
35
37
*/
36
38
37
39
export const buildConfig = (tailwindConfig, coreUtils, themeKey, ...fallbackKeys) => {
···
48
50
49
51
/**
50
52
* getSettings()
53
+
*
51
54
* @param {function|Object} theme
52
55
* @param {string} themeKey
53
56
* @param {string[]} fallbackKeys
···
66
69
67
70
/**
68
71
* buildPlugin()
69
-
* @param {*} pluginUtilities
70
-
* @param {*} coreUtils
72
+
*
73
+
* @param {Object} tailwindConfig
74
+
* @param {Object} coreUtils
75
+
* @param {Object} pluginRecipe
71
76
*/
72
-
73
77
export const buildPlugin = (tailwindConfig, coreUtils, pluginRecipe) => {
74
78
const { addUtilities, e, variants } = coreUtils
75
79
const buildFromRecipe = ([key, value]) => [key, buildConfig(tailwindConfig, coreUtils, ...value)]
···
93
97
94
98
/**
95
99
* generatePluginCss()
100
+
*
96
101
* @param {Object} tailwindConfig
97
102
* @param {Object} testConfig
98
103
*/