Home > @rushstack/ts-command-line > CommandLineParameter > undocumentedSynonyms

CommandLineParameter.undocumentedSynonyms property

Specifies additional names for this parameter that are accepted but not displayed in the command line help.

Signature:

readonly undocumentedSynonyms: string[] | undefined;

Remarks

This option can be used in cases where a command-line parameter may have been renamed, but the developer doesn't want to break backwards compatibility with systems that may still be using the old name. Only the parameterLongName syntax is currently allowed.