Home > @rushstack/ts-command-line > CommandLineParser > execute

CommandLineParser.execute() method

The program entry point will call this method to begin parsing command-line arguments and executing the corresponding action.

Signature:

execute(args?: string[]): Promise<boolean>;

Parameters

Parameter	Type	Description
args	string[]	(Optional) the command-line arguments to be parsed; if omitted, then the process.argv will be used

Returns:

Promise<boolean>

Remarks

The returned promise will never reject: If an error occurs, it will be printed to stderr, process.exitCode will be set to 1, and the promise will resolve to false. This simplifies the most common usage scenario where the program entry point doesn't want to be involved with the command-line logic, and will discard the promise without a then() or catch() block.

If your caller wants to trap and handle errors, use CommandLineParser.executeWithoutErrorHandling() instead.