Home > @rushstack/ts-command-line > CommandLineFlagParameter

CommandLineFlagParameter class

The data type returned by CommandLineParameterProvider.defineFlagParameter().

Signature:

export declare class CommandLineFlagParameter extends CommandLineParameterBase 

Extends: CommandLineParameterBase

Remarks

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the CommandLineFlagParameter class.

Properties

Property	Modifiers	Type	Description
kind	readonly	CommandLineParameterKind.Flag	Indicates the type of parameter.
value	readonly	boolean	Returns a boolean indicating whether the parameter was included in the command line.

Methods

Method	Modifiers	Description
appendToArgList(argList)		Append the parsed values to the provided string array.