Add shouldRemoveUndefinedFromOptional parser option

README.md

@@ -270,6 +270,7 @@ stories.add(
 | shouldExtractLiteralValuesFromEnum | boolean                    | If set to true, string enums and unions will be converted to docgen enum format. Useful if you use Storybook and want to generate knobs automatically using [addon-smart-knobs](https://github.com/storybookjs/addon-smart-knobs). https://github.com/styleguidist/react-docgen-typescript#parseroptions                                                    |
 | savePropValueAsString              | boolean                    | If set to true, defaultValue to props will be string. https://github.com/styleguidist/react-docgen-typescript#parseroptions                                                                                                                                                                                                                                 |
 | typePropName                       | string                     | Specify the name of the property for docgen info prop type.                                                                                                                                                                                                                                                                                                 |
+| shouldRemoveUndefinedFromOptional  | boolean                    | If set to true, types that are optional will not display `| undefined` in the type. https://github.com/styleguidist/react-docgen-typescript#parseroptions                                                                                                                                                                                                                                                                                                |
 
 ## Performance
 

package.json

@@ -35,7 +35,7 @@
   "dependencies": {
     "@webpack-contrib/schema-utils": "^1.0.0-beta.0",
     "loader-utils": "^1.2.3",
-    "react-docgen-typescript": "^1.15.0"
+    "react-docgen-typescript": "^1.16.5"
   },
   "peerDependencies": {
     "typescript": "*"

src/LoaderOptions.ts

@@ -76,4 +76,11 @@ export default interface LoaderOptions {
    * @default "type"
    */
   typePropName?: string;
+
+  /**
+   * If set to true, types that are optional will not display " | undefined" in the type.
+   *
+   * @default false
+   */
+  shouldRemoveUndefinedFromOptional?: boolean;
 }

src/loader.ts

@@ -82,6 +82,8 @@ function processResource(
     shouldExtractLiteralValuesFromEnum:
       options.shouldExtractLiteralValuesFromEnum,
     savePropValueAsString: options.savePropValueAsString,
+    shouldRemoveUndefinedFromOptional:
+      options.shouldRemoveUndefinedFromOptional,
   };
 
   // Configure parser using settings provided to loader.

src/validateOptions.ts

@@ -68,6 +68,10 @@ const schema = {
     typePropName: {
       type: "string",
     },
+
+    shouldRemoveUndefinedFromOptional: {
+      type: "boolean",
+    },
   },
 };
 

yarn.lock

@@ -3979,10 +3979,10 @@ rc@^1.2.7:
     minimist "^1.2.0"
     strip-json-comments "~2.0.1"
 
-react-docgen-typescript@^1.15.0:
-  version "1.15.0"
-  resolved "https://registry.yarnpkg.com/react-docgen-typescript/-/react-docgen-typescript-1.15.0.tgz#963f14210841f9b51ed18c65152a6cc37f1c3184"
-  integrity sha512-8xObdkRQbrc0505tEdVRO+pdId8pKFyD6jhLYM9FDdceKma+iB+a17Dk7e3lPRBRh8ArQLCedOCOfN/bO338kw==
+react-docgen-typescript@^1.16.5:
+  version "1.16.5"
+  resolved "https://registry.yarnpkg.com/react-docgen-typescript/-/react-docgen-typescript-1.16.5.tgz#b305563425ab370f5a3c82b42579eb5069449b87"
+  integrity sha512-guXnx6a554IDVUoVIkX/BGRTrwc2n2w/kMxo7TKLNLJW1qszhT6BRHX4qV8eWq5eaJxRxuesOW5AOLiOI9WQOA==
 
 react-is@^16.8.4:
   version "16.9.0"