docs: unwrap nested named union and literal types (#1965)

faker-js · Mar 29, 2023 · a6e6104 · a6e6104
1 parent 8516bfb
commit a6e6104
Show file tree

Hide file tree

Showing 3 changed files with 82 additions and 27 deletions.
diff --git a/scripts/apidoc/signature.ts b/scripts/apidoc/signature.ts
@@ -304,7 +304,17 @@ function typeToText(type_?: Type, short = false): string {
 
     case 'reference':
       if (!type.typeArguments || !type.typeArguments.length) {
-        return type.name;
+        const reflection = type.reflection as DeclarationReflection | undefined;
+        const reflectionType = reflection?.type;
+        if (
+          (reflectionType?.type === 'literal' ||
+            reflectionType?.type === 'union') &&
+          !type.name.match(/Char$/)
+        ) {
+          return typeToText(reflectionType, short);
+        } else {
+          return type.name;
+        }
       } else if (type.name === 'LiteralUnion') {
         return [
           typeToText(type.typeArguments[0], short),