Add missing API exports

pgonzal · pgonzal · commit eceace004b35 · 2018-04-16T18:46:25.000-07:00
diff --git a/common/reviews/api/ts-command-line.api.ts b/common/reviews/api/ts-command-line.api.ts
@@ -91,6 +91,13 @@ class CommandLineParameterProvider {
   renderHelpText(): string;
 }
 
+// @public
+class CommandLineParameterWithArgument<T> extends CommandLineParameter<T> {
+  // @internal
+  constructor(definition: IBaseCommandLineDefinitionWithArgument);
+  readonly argumentName: string | undefined;
+}
+
 // @public
 class CommandLineParser extends CommandLineParameterProvider {
   constructor(options: ICommandLineParserOptions);
@@ -138,6 +145,11 @@ interface IBaseCommandLineDefinition {
   parameterShortName?: string;
 }
 
+// @public
+interface IBaseCommandLineDefinitionWithArgument extends IBaseCommandLineDefinition {
+  argumentName: string;
+}
+
 // @public
 interface ICommandLineActionOptions {
   actionVerb: string;
diff --git a/libraries/ts-command-line/src/CommandLineDefinition.ts b/libraries/ts-command-line/src/CommandLineDefinition.ts
@@ -23,6 +23,14 @@ export interface IBaseCommandLineDefinition {
   description: string;
 }
 
+/**
+ * The common base interface for parameter types that accept an argument.
+ *
+ * @remarks
+ * An argument is an accompanying command-line token, such as "123" in the
+ * example "--max-count 123".
+ * @public
+ */
 export interface IBaseCommandLineDefinitionWithArgument extends IBaseCommandLineDefinition {
   /**
    * The name of the argument, which will be shown in the command-line help.
diff --git a/libraries/ts-command-line/src/CommandLineParameter.ts b/libraries/ts-command-line/src/CommandLineParameter.ts
@@ -96,6 +96,14 @@ export abstract class CommandLineParameter<T> {
   public abstract get kind(): CommandLineParameterKind;
 }
 
+/**
+ * The common base class for parameters types that receive an argument.
+ *
+ * @remarks
+ * An argument is an accompanying command-line token, such as "123" in the
+ * example "--max-count 123".
+ * @public
+ */
 export abstract class CommandLineParameterWithArgument<T> extends CommandLineParameter<T> {
   private static _invalidArgumentNameRegExp: RegExp = /[^A-Z_0-9]/;
 
diff --git a/libraries/ts-command-line/src/index.ts b/libraries/ts-command-line/src/index.ts
@@ -14,6 +14,7 @@ export {
 
 export {
   IBaseCommandLineDefinition,
+  IBaseCommandLineDefinitionWithArgument,
   ICommandLineFlagDefinition,
   ICommandLineStringDefinition,
   ICommandLineStringListDefinition,
@@ -24,6 +25,7 @@ export {
 export {
   CommandLineParameterKind,
   CommandLineParameter,
+  CommandLineParameterWithArgument,
   CommandLineStringParameter,
   CommandLineStringListParameter,
   CommandLineFlagParameter,
