Modify return type depending on storeOptionsAsProperties parameter (#1424)

Author: shadowspawn

typings/commander-tests.ts

@@ -132,8 +132,16 @@ const createOption2: commander.Option = program.createOption('a, --alpha', 'desc
 const addOptionThis: commander.Command = program.addOption(new commander.Option('-s,--simple'));
 
 // storeOptionsAsProperties
+// chaining
 const storeOptionsAsPropertiesThis1: commander.Command = program.storeOptionsAsProperties();
 const storeOptionsAsPropertiesThis2: commander.Command = program.storeOptionsAsProperties(false);
+// return type depends on parameter
+const storeOptionsAsPropertiesThis3 = program.storeOptionsAsProperties();
+const storeOptionsAsPropertiesValue3 = storeOptionsAsPropertiesThis3.someOption;
+const storeOptionsAsPropertiesThis4 = program.storeOptionsAsProperties(true);
+const storeOptionsAsPropertiesValue4 = storeOptionsAsPropertiesThis4.someOption;
+const storeOptionsAsPropertiesThis5 = program.storeOptionsAsProperties(false);
+// const storeOptionsAsPropertiesValue5 = storeOptionsAsPropertiesThis5.someOption; // error
 
 // combineFlagAndOptionalValue
 const combineFlagAndOptionalValueThis1: commander.Command = program.combineFlagAndOptionalValue();

typings/index.d.ts

@@ -148,6 +148,10 @@ declare namespace commander {
 
   type AddHelpTextPosition = 'beforeAll' | 'before' | 'after' | 'afterAll';
 
+  interface OptionValues {
+    [key: string]: any;
+  }
+
   interface Command {
     args: string[];
 
@@ -372,6 +376,8 @@ declare namespace commander {
      *
      * @returns `this` command for chaining
      */
+    storeOptionsAsProperties(): this & OptionValues;
+    storeOptionsAsProperties(storeAsProperties: true): this & OptionValues;
     storeOptionsAsProperties(storeAsProperties?: boolean): this;
 
     /**
@@ -450,7 +456,7 @@ declare namespace commander {
     /**
      * Return an object containing options as key-value pairs
      */
-    opts(): { [key: string]: any };
+    opts(): OptionValues;
 
     /**
      * Set the description.