Merge pull request #2721 from Corso02/master

TypeDoc displays a superfluous type on number constants implementation
TypeStrong · Oct 3, 2024 · 1dbfe3a · 1dbfe3a
2 parents 3723b58 + b9f56e0
commit 1dbfe3a
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 2 deletions.
diff --git a/src/lib/converter/symbols.ts b/src/lib/converter/symbols.ts
@@ -968,7 +968,6 @@ function convertVariable(
     setModifiers(symbol, declaration, reflection);
 
     reflection.defaultValue = convertDefaultValue(declaration);
-
     context.finalizeDeclarationReflection(reflection);
 
     return ts.SymbolFlags.Property;

diff --git a/src/lib/output/themes/default/partials/member.declaration.tsx b/src/lib/output/themes/default/partials/member.declaration.tsx
@@ -29,12 +29,26 @@ export function memberDeclaration(context: DefaultThemeRenderContext, props: Dec
 
     const visitor = { reflection: renderTypeDeclaration };
 
+    /** Fix for #2717. If type is the same as value the type is omitted */
+    function shouldRenderType() {
+        if (props.type && props.type.type === "literal") {
+            const reflectionTypeString = props.type.toString();
+
+            const defaultValue = props.defaultValue;
+
+            if (defaultValue === undefined || reflectionTypeString === defaultValue.toString()) {
+                return false;
+            }
+        }
+        return true;
+    }
+
     return (
         <>
             <div class="tsd-signature">
                 <span class={getKindClass(props)}>{wbr(props.name)}</span>
                 {renderTypeParametersSignature(context, props.typeParameters)}
-                {props.type && (
+                {shouldRenderType() && (
                     <>
                         <span class="tsd-signature-symbol">{!!props.flags.isOptional && "?"}:</span>{" "}
                         {context.type(props.type)}