@sfdx-falcon/builder-library
Version:
Collection of functions for building pre-defined SFDX-Falcon Tasks, Questions, and Task Bundles. Allows developers to quickly build common Task and Interview-driven workflows in their CLI plugins. Part of the SFDX-Falcon Library.
47 lines (46 loc) • 1.89 kB
TypeScript
/**
* @author Vivek M. Chawla <@VivekMChawla>
* @copyright 2019, Vivek M. Chawla / Salesforce. All rights reserved.
* @license BSD-3-Clause For full license text, see the LICENSE file in the repo root or
* `https://opensource.org/licenses/BSD-3-Clause`
* @file packages/builder-library/src/questions/general.ts
* @summary Exports `Builder` classes for general questions.
* @description Exports `Builder` classes for general questions.
*/
import { InterviewQuestionsBuilder } from '@sfdx-falcon/builder';
import { InterviewQuestionsBuilderOptions } from '@sfdx-falcon/builder';
import { Questions } from '@sfdx-falcon/types';
/**
* Interface. Specifies options for the `ConfirmProceedRestart` constructor.
*/
export interface ConfirmProceedRestartOptions extends InterviewQuestionsBuilderOptions {
msgStrings: {
promptConfirmation?: string;
promptStartOver?: string;
};
}
/**
* @class ConfirmProceedRestart
* @extends InterviewQuestionsBuilder
* @description Asks the user to confirm that they want to proceed with an operation based on the
* values that they have previously provided during an Interview. If they say "no",
* they will be asked if they want to restart. If they choose not to restart, they
* are effectively aborting the operation.
* @public
*/
export declare class ConfirmProceedRestart extends InterviewQuestionsBuilder {
promptConfirmation: string;
promptStartOver: string;
/**
* @constructs ConfirmProceedRestart
* @param {ConfirmProceedRestartOptions} opts Required.
*/
constructor(opts: ConfirmProceedRestartOptions);
/**
* @method build
* @returns {Questions}
* @description Builds the Interview Questions.
* @public
*/
build(): Questions;
}