@wcauchois/program-builder > ProgramBuilder > stringFlag

ProgramBuilder.stringFlag() method

Add a required valued flag to the program.

Signature:
stringFlag<K extends string>(name: string, options: INonNullValuedFlagOptions<K, string>): ExtendProgramBuilderWithRequired<T, K, string>;

Parameters

ParameterTypeDescription
name
string
The name for the flag, including leading dashes. Multiple alternative names may be specified by separating them within the string by commas. For example, "-i,--input".
optionsINonNullValuedFlagOptions<K, string>See INonNullValuedFlagOptions.
Returns:

ExtendProgramBuilderWithRequired<T, K, string>