Refactor code-style

* Add more docs to JSDoc * Add support for `null` in input of API types
syntax-tree · Jan 23, 2023 · fbbd4ba · fbbd4ba
1 parent fac66a0
commit fbbd4ba
Showing 1 changed file with 40 additions and 38 deletions.
diff --git a/lib/index.js b/lib/index.js
@@ -3,58 +3,60 @@
  * @typedef {import('unist').Parent} Parent
  * @typedef {import('unist').Literal} Literal
  * @typedef {Record<string, unknown>} Props
- * @typedef {Array<Node>|string} ChildrenOrValue
- *
- * @typedef {(<T extends string, P extends Record<string, unknown>, C extends Array<Node>>(type: T, props: P, children: C) => {type: T, children: C} & P)} BuildParentWithProps
- * @typedef {(<T extends string, P extends Record<string, unknown>>(type: T, props: P, value: string) => {type: T, value: string} & P)} BuildLiteralWithProps
- * @typedef {(<T extends string, P extends Record<string, unknown>>(type: T, props: P) => {type: T} & P)} BuildVoidWithProps
- * @typedef {(<T extends string, C extends Array<Node>>(type: T, children: C) => {type: T, children: C})} BuildParent
- * @typedef {(<T extends string>(type: T, value: string) => {type: T, value: string})} BuildLiteral
- * @typedef {(<T extends string>(type: T) => {type: T})} BuildVoid
+ * @typedef {Array<Node> | string} ChildrenOrValue
  */
 
 /**
  * Build a node.
  *
  * @param type
  *   Node type.
- * @param [props]
+ * @param props
  *   Fields assigned to node.
- * @param [value]
+ * @param value
  *   Children of node or value of `node` (cast to string).
  * @returns
  *   Built node.
  */
-export const u = /**
- * @type {BuildVoid & BuildVoidWithProps & BuildLiteral & BuildLiteralWithProps & BuildParent & BuildParentWithProps}
- */ (
+export const u =
   /**
-   * @param {string} type
-   * @param {Props|ChildrenOrValue} [props]
-   * @param {ChildrenOrValue} [value]
-   * @returns {Node}
+   * @type {(
+   *   (<T extends string>(type: T) => {type: T}) &
+   *   (<T extends string, P extends Props>(type: T, props: P) => {type: T} & P) &
+   *   (<T extends string>(type: T, value: string) => {type: T, value: string}) &
+   *   (<T extends string, P extends Props>(type: T, props: P, value: string) => {type: T, value: string} & P) &
+   *   (<T extends string, C extends Array<Node>>(type: T, children: C) => {type: T, children: C}) &
+   *   (<T extends string, P extends Props, C extends Array<Node>>(type: T, props: P, children: C) => {type: T, children: C} & P)
+   * )}
    */
-  function (type, props, value) {
-    /** @type {Node} */
-    const node = {type: String(type)}
+  (
+    /**
+     * @param {string} type
+     * @param {Props | ChildrenOrValue | null | undefined} [props]
+     * @param {ChildrenOrValue | null | undefined} [value]
+     * @returns {Node}
+     */
+    function (type, props, value) {
+      /** @type {Node} */
+      const node = {type: String(type)}
 
-    if (
-      (value === undefined || value === null) &&
-      (typeof props === 'string' || Array.isArray(props))
-    ) {
-      value = props
-    } else {
-      Object.assign(node, props)
-    }
+      if (
+        (value === undefined || value === null) &&
+        (typeof props === 'string' || Array.isArray(props))
+      ) {
+        value = props
+      } else {
+        Object.assign(node, props)
+      }
 
-    if (Array.isArray(value)) {
-      // @ts-expect-error: create a parent.
-      node.children = value
-    } else if (value !== undefined && value !== null) {
-      // @ts-expect-error: create a literal.
-      node.value = String(value)
-    }
+      if (Array.isArray(value)) {
+        // @ts-expect-error: create a parent.
+        node.children = value
+      } else if (value !== undefined && value !== null) {
+        // @ts-expect-error: create a literal.
+        node.value = String(value)
+      }
 
-    return node
-  }
-)
+      return node
+    }
+  )