Add getOptionValueSourceWithGlobals (#18)

commander-js · Dec 19, 2022 · 536ef60 · 536ef60
1 parent c0a96ab
commit 536ef60
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/index.d.ts b/index.d.ts
@@ -775,11 +775,17 @@ export class CommanderError extends Error {
      setOptionValueWithSource(key: string, value: unknown, source: OptionValueSource): this;
 
     /**
-     * Retrieve option value source.
+     * Get source of option value.
      */
      getOptionValueSource<K extends keyof Opts>(key: K): OptionValueSource | undefined;
      getOptionValueSource(key: string): OptionValueSource | undefined;
 
+    /**
+     * Get source of option value. See also .optsWithGlobals().
+     */
+    getOptionValueSourceWithGlobals<K extends keyof Opts>(key: K): OptionValueSource | undefined;
+    getOptionValueSourceWithGlobals(key: string): OptionValueSource | undefined;
+
     /**
      * Alter parsing of short flags with optional values.
      *

diff --git a/tests/commander.test-d.ts b/tests/commander.test-d.ts
@@ -189,6 +189,9 @@ expectChainedCommand(program.setOptionValueWithSource('example', [], 'cli'));
 // getOptionValueSource
 expectType<commander.OptionValueSource | undefined>(program.getOptionValueSource('example'));
 
+// getOptionValueSourceWithGlobals
+expectType<commander.OptionValueSource | undefined>(program.getOptionValueSourceWithGlobals('example'));
+
 // combineFlagAndOptionalValue
 expectChainedCommand(program.combineFlagAndOptionalValue());
 expectChainedCommand(program.combineFlagAndOptionalValue(false));