From 71a9918db88dbb0bebfac2b26888ebf8926a3704 Mon Sep 17 00:00:00 2001
From: ST-DDT <ST-DDT@gmx.de>
Date: Fri, 8 Apr 2022 16:50:41 +0200
Subject: docs: nice literal unions (#811)

---
 scripts/apidoc/moduleMethods.ts | 2 +-
 scripts/apidoc/signature.ts     | 7 ++++++-
 2 files changed, 7 insertions(+), 2 deletions(-)

(limited to 'scripts')

diff --git a/scripts/apidoc/moduleMethods.ts b/scripts/apidoc/moduleMethods.ts
index 7b090d13..3d81c2db 100644
--- a/scripts/apidoc/moduleMethods.ts
+++ b/scripts/apidoc/moduleMethods.ts
@@ -1,6 +1,6 @@
 import * as TypeDoc from 'typedoc';
 import type { Method } from '../../docs/.vitepress/components/api-docs/method';
-import faker from '../../src';
+import { faker } from '../../src';
 import { writeApiDocsData, writeApiDocsModulePage } from './apiDocsWriter';
 import { analyzeSignature, toBlock } from './signature';
 import type { PageIndex } from './utils';
diff --git a/scripts/apidoc/signature.ts b/scripts/apidoc/signature.ts
index 31674c83..dafd2c6d 100644
--- a/scripts/apidoc/signature.ts
+++ b/scripts/apidoc/signature.ts
@@ -14,7 +14,7 @@ import type {
   Method,
   MethodParameter,
 } from '../../docs/.vitepress/components/api-docs/method';
-import faker from '../../src';
+import { faker } from '../../src';
 import { pathOutputDir } from './utils';
 // TODO ST-DDT 2022-02-20: Actually import this/fix module import errors
 // import vitepressConfig from '../../docs/.vitepress/config';
@@ -228,6 +228,11 @@ function typeToText(type_: Type, short = false): string {
     case 'reference':
       if (!type.typeArguments || !type.typeArguments.length) {
         return type.name;
+      } else if (type.name === 'LiteralUnion') {
+        return [
+          typeToText(type.typeArguments[0]),
+          typeToText(type.typeArguments[1]),
+        ].join(' | ');
       } else {
         return `${type.name}<${type.typeArguments
           .map((t) => typeToText(t, short))
-- 
cgit v1.2.3