docs(jsdoc): add for classNames()

tentjs · Dec 5, 2023 · 410ce6f · 410ce6f
1 parent 03b9559
commit 410ce6f
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/lib/one.js b/lib/one.js
@@ -191,6 +191,18 @@ function router(el, routes) {
   handler()
 }
 
+/**
+  * A helper method to add classes conditionally.
+  * @param {string[]} classes
+  * @example
+  * ```js
+  * classNames(
+  *   'class-1',
+  *   true && 'class-2',
+  *   false && 'class-3',
+  *  )
+  *  ```
+  */
 function classNames(...classes) {
   return classes.filter(Boolean).join(' ')
 }