Home > @rushstack/ts-command-line > CommandLineParameterProvider > defineIntegerParameter

CommandLineParameterProvider.defineIntegerParameter() method

Defines a command-line parameter whose argument is an integer.

Signature:

defineIntegerParameter(definition: ICommandLineIntegerDefinition & {
        defaultValue: number;
    }): IRequiredCommandLineIntegerParameter;

Parameters

Parameter	Type	Description
definition	ICommandLineIntegerDefinition & { defaultValue: number; }

Returns:

IRequiredCommandLineIntegerParameter

Remarks

Example usage of an integer parameter:

example-tool --max-attempts 5