@zowe/imperative/lib/cmd/src/yargs/doc/IYargsParms.d.ts

framework for building configurable CLIs

import { Argv } from "yargs";
import { ICommandDefinition } from "../../doc/ICommandDefinition";
import { GroupCommandYargs } from "../GroupCommandYargs";
import { ICommandResponseParms } from "../../doc/response/parms/ICommandResponseParms";
import { IHelpGeneratorFactory } from "../../help/doc/IHelpGeneratorFactory";
/**
 * Imperative Yargs parameters - used to define imperative commands to Yargs and provides guidance/parameters for
 * how response objects should be handled when yargs invokes the handlers.
 * @export
 * @interface IYargsParms
 */
export interface IYargsParms {
    /**
     * The instance of Yargs to define the commands.
     * @type {Argv}
     * @memberof IYargsParms
     */
    yargsInstance: Argv;
    /**
     * The command definition document.
     * @type {ICommandDefinition}
     * @memberof IYargsParms
     */
    commandDefinition: ICommandDefinition;
    /**
     * The command response parameters normally scraped from the Imperative configuration document.
     *
     * @type {ICommandResponseParms}
     * @memberof IYargsParms
     */
    commandResponseParms: ICommandResponseParms;
    /**
     * The help generator factory to be used in this CLI help generation
     * @type {AbstractHelpGeneratorFactory}
     * @memberof IYargsParms
     */
    helpGeneratorFactory: IHelpGeneratorFactory;
    /**
     * Optionally override the experimental command help text block.
     * Used to propagate the user's configuration down to different yargs/cmd services.
     * @type {string}
     * @memberof IYargsParms
     */
    experimentalCommandDescription: string;
    /**
     * Root command name of the CLI.
     * @type {string}
     * @memberof IYargsParms
     */
    rootCommandName: string;
    /**
     * The command line.
     * @type {string}
     * @memberof IYargsParms
     */
    commandLine: string;
    /**
     * Environmental variable name prefix used to construct configuration environmental variables.
     * @type {string}
     * @memberof IYargsParms
     */
    envVariablePrefix: string;
    /**
     * The Yargs Parent object - only has meaning for nested/group commands.
     * @type {GroupCommandYargs}
     * @memberof IYargsParms
     */
    yargsParent?: GroupCommandYargs;
    /**
     * The phrase used to indicate the user wants to enter the value of an argument in a hidden text prompt
     * @type {string}
     * @memberof IYargsParms
     */
    promptPhrase: string;
}
//# sourceMappingURL=IYargsParms.d.ts.map