Make Option.env() behave as getter when no name supplied

tj · Aug 15, 2023 · 8a050cc · 8a050cc
1 parent 880b028
commit 8a050cc
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 4 deletions.
diff --git a/lib/option.js b/lib/option.js
@@ -109,16 +109,17 @@ class Option {
   }
 
   /**
-   * Set environment variable to check for option value.
+   * Get or set environment variable to check for option value.
    *
    * An environment variable is only used if when processed the current option value is
    * undefined, or the source of the current value is 'default' or 'config' or 'env'.
    *
-   * @param {string} name
-   * @return {Option}
+   * @param {string} [name]
+   * @return {Option | string | undefined}
    */
 
   env(name) {
+    if (!name) return this.envVar;
     this.envVar = name;
     return this;
   }

diff --git a/typings/index.d.ts b/typings/index.d.ts
@@ -142,12 +142,13 @@ export class Option {
   implies(optionValues: OptionValues): this;
 
   /**
-   * Set environment variable to check for option value.
+   * Get or set environment variable to check for option value.
    *
    * An environment variables is only used if when processed the current option value is
    * undefined, or the source of the current value is 'default' or 'config' or 'env'.
    */
   env(name: string): this;
+  env(): string | undefined;
 
   /**
    * Calculate the full description, including defaultValue etc.

diff --git a/typings/index.test-d.ts b/typings/index.test-d.ts
@@ -410,6 +410,7 @@ expectType<commander.Option>(baseOption.preset('abc'));
 
 // env
 expectType<commander.Option>(baseOption.env('PORT'));
+expectType<string | undefined>(baseOption.env());
 
 // fullDescription
 expectType<string>(baseOption.fullDescription());