Rush StackShopBlogEvents
Skip to main content

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

CommandLineParameterProvider.defineIntegerParameter() method​

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

Signature:

defineIntegerParameter(definition: ICommandLineIntegerDefinition & {
        required: false | undefined;
        defaultValue: undefined;
    }): CommandLineIntegerParameter;

Parameters​

Parameter

Type

Description

definition

ICommandLineIntegerDefinition & { required: false | undefined; defaultValue: undefined; }

Returns:

CommandLineIntegerParameter

Remarks​

Example usage of an integer parameter:

example-tool --max-attempts 5