@zowe/imperative/lib/rest/src/session/doc/IOverridePromptConnProps.d.ts

framework for building configurable CLIs

import { ISession } from "./ISession";
/**
 * Interface for overriding the prompting behavior of ConnectionPropsForSessCfg.addPropsOrPrompt()
 * @export
 * @interface IOverridePromptConnProps
 */
export interface IOverridePromptConnProps<SessCfgType extends ISession = ISession> {
    /**
     * Indicates the session property that should be considered in the prompting logic.
     */
    propertyName: string;
    /**
     * Indicates the CLI argument that should be used to populate the property on the session.
     * If not supplied, uses a CLI argument that matches the session property name.
     */
    argumentName?: string;
    /**
     * Indicates the prompting fields the property should override. For example, if the property should be the preferred method of authentication,
     * then it should override user and password. Then, if the property is on the session, it will not prompt for user and password.
     * Prompting logic is only in place for host, port, user, and password, but cert, certKey, tokenType, and tokenValue may also need
     * to be overridden.
     */
    propertiesOverridden: (keyof SessCfgType & string)[];
    /**
     * Allows passing additional properties for which to prompt.
     * Used in cases of an incorrect or missing key passphrase.
     */
    propsToPromptFor?: (keyof SessCfgType & string)[];
}
//# sourceMappingURL=IOverridePromptConnProps.d.ts.map