Add strong typing of .opts() using generics (#1539)

Co-authored-by: tyankatsu <frips.ryilsufupe+dev@gmail.com> Co-authored-by: tyankatsu <frips.ryilsufupe+dev@gmail.com>
tj · May 30, 2021 · 03d2147 · 03d2147
1 parent f9fe294
commit 03d2147
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 3 deletions.
diff --git a/typings/index.d.ts b/typings/index.d.ts
@@ -483,8 +483,8 @@ export class Command {
    *
    * @returns `this` command for chaining
    */
-  storeOptionsAsProperties(): this & OptionValues;
-  storeOptionsAsProperties(storeAsProperties: true): this & OptionValues;
+  storeOptionsAsProperties<T extends OptionValues>(): this & T;
+  storeOptionsAsProperties<T extends OptionValues>(storeAsProperties: true): this & T;
   storeOptionsAsProperties(storeAsProperties?: boolean): this;
 
   /**
@@ -594,7 +594,7 @@ export class Command {
   /**
    * Return an object containing options as key-value pairs
    */
-  opts(): OptionValues;
+  opts<T extends OptionValues>(): T;
 
   /**
    * Set the description.

diff --git a/typings/index.test-d.ts b/typings/index.test-d.ts
@@ -196,6 +196,15 @@ expectType<commander.OptionValues>(opts);
 expectType(opts.foo);
 expectType(opts['bar']);
 
+// opts with generics
+interface MyCheeseOption {
+  cheese: string;
+}
+const myCheeseOption = program.opts<MyCheeseOption>();
+expectType<string>(myCheeseOption.cheese);
+// @ts-expect-error Check that options strongly typed and does not allow arbitrary properties
+expectType(myCheeseOption.foo);
+
 // description
 expectType<commander.Command>(program.description('my description'));
 expectType<string>(program.description());