fix: Remove undefined from optional property types

Resolves #1525
TypeStrong · Mar 5, 2021 · c9faa9b · c9faa9b
1 parent 6fb01a0
commit c9faa9b
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 44 deletions.
diff --git a/src/lib/converter/symbols.ts b/src/lib/converter/symbols.ts
@@ -21,6 +21,7 @@ import { ConverterEvents } from "./converter-events";
 import { convertIndexSignature } from "./factories/index-signature";
 import { createSignature } from "./factories/signature";
 import { convertJsDocAlias, convertJsDocCallback } from "./jsdoc";
+import { removeUndefined } from "./utils/reflections";
 
 const symbolConverters: {
     [K in ts.SymbolFlags]?: (
@@ -601,6 +602,10 @@ function convertProperty(
         (context.isConvertingTypeNode() ? parameterType : void 0) ??
             context.checker.getTypeOfSymbolAtLocation(symbol, {} as any)
     );
+
+    if (reflection.flags.isOptional) {
+        reflection.type = removeUndefined(reflection.type);
+    }
 }
 
 function convertArrowAsMethod(

diff --git a/src/test/converter/class/specs-with-lump-categories.json b/src/test/converter/class/specs-with-lump-categories.json
@@ -358,17 +358,8 @@
                     "isOptional": true
                   },
                   "type": {
-                    "type": "union",
-                    "types": [
-                      {
-                        "type": "intrinsic",
-                        "name": "undefined"
-                      },
-                      {
-                        "type": "intrinsic",
-                        "name": "number"
-                      }
-                    ]
+                    "type": "intrinsic",
+                    "name": "number"
                   }
                 }
               ],
@@ -412,17 +403,8 @@
                     "isReadonly": true
                   },
                   "type": {
-                    "type": "union",
-                    "types": [
-                      {
-                        "type": "intrinsic",
-                        "name": "undefined"
-                      },
-                      {
-                        "type": "intrinsic",
-                        "name": "number"
-                      }
-                    ]
+                    "type": "intrinsic",
+                    "name": "number"
                   }
                 }
               ],

diff --git a/src/test/converter/class/specs.json b/src/test/converter/class/specs.json
@@ -358,17 +358,8 @@
                     "isOptional": true
                   },
                   "type": {
-                    "type": "union",
-                    "types": [
-                      {
-                        "type": "intrinsic",
-                        "name": "undefined"
-                      },
-                      {
-                        "type": "intrinsic",
-                        "name": "number"
-                      }
-                    ]
+                    "type": "intrinsic",
+                    "name": "number"
                   }
                 }
               ],
@@ -412,17 +403,8 @@
                     "isReadonly": true
                   },
                   "type": {
-                    "type": "union",
-                    "types": [
-                      {
-                        "type": "intrinsic",
-                        "name": "undefined"
-                      },
-                      {
-                        "type": "intrinsic",
-                        "name": "number"
-                      }
-                    ]
+                    "type": "intrinsic",
+                    "name": "number"
                   }
                 }
               ],