Skip to content

fix option type definition to match usage. #1119

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shadowspawn merged 12 commits into from
Jan 9, 2020
Merged

fix option type definition to match usage. #1119

Changes from 11 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
67cc79c
fix option type def
UrielCh Dec 12, 2019
de995da
add test
UrielCh Dec 12, 2019
78fa81d
change definition order
UrielCh Dec 18, 2019
5129c97
change def order
UrielCh Dec 18, 2019
cd8fd03
fix typing
UrielCh Dec 18, 2019
5823a8e
improve typing enforce current implementation
UrielCh Dec 24, 2019
c9b5deb
final patch
UrielCh Dec 28, 2019
7933511
drop all void returning option
UrielCh Dec 28, 2019
9de970b
fix missing boolean type for default value
UrielCh Dec 31, 2019
383afb6
clean code
UrielCh Dec 31, 2019
7426210
clean code
UrielCh Dec 31, 2019
5893749
Merge branch 'release/5.x' into master
UrielCh Jan 6, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 6 additions & 10 deletions typings/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,24 +162,20 @@ declare namespace commander {
*
* // optional argument
* program.option('-c, --cheese [type]', 'add cheese [marble]');
*
* @param {string} flags
* @param {string} [description]
* @param {((arg1: any, arg2: any) => void) | RegExp} [fn] function or default
* @param {*} [defaultValue]
* @returns {Command} for chaining
*/
option(flags: string, description?: string, fn?: ((arg1: any, arg2: any) => void) | RegExp, defaultValue?: any): Command;
option(flags: string, description?: string, defaultValue?: any): Command;
option(flags: string, description?: string, defaultValue?: string | boolean): Command;
option(flags: string, description: string, regexp: RegExp, defaultValue?: string | boolean): Command;
option<T>(flags: string, description: string, fn: (value: string, previous: T) => T, defaultValue?: T): Command;

/**
* Define a required option, which must have a value after parsing. This usually means
* the option must be specified on the command line. (Otherwise the same as .option().)
*
* The `flags` string should contain both the short and long flags, separated by comma, a pipe or space.
*/
requiredOption(flags: string, description?: string, fn?: ((arg1: any, arg2: any) => void) | RegExp, defaultValue?: any): Command;
requiredOption(flags: string, description?: string, defaultValue?: any): Command;
requiredOption(flags: string, description?: string, defaultValue?: string | boolean): Command;
requiredOption(flags: string, description: string, regexp: RegExp, defaultValue?: string | boolean): Command;
requiredOption<T>(flags: string, description: string, fn: (value: string, previous: T) => T, defaultValue?: T): Command;

/**
* Allow unknown options on the command line.
Expand Down