easy-cli-framework/dist/prompts/prompt-multiple-choice.d.ts

A framework for building CLI applications that are robust and easy to maintain. Supports theming, configuration files, interactive prompts, and more.

import { DisplayOptions, EasyCLITheme } from '../themes';
/**
 * Options for the promptMultipleChoice function
 *
 * @interface PromptMultipleChoiceOptions
 * @type {object}
 *
 * @property {string[]} [defaultSelected=[]] The default selected options
 * @property {(input: string[]) => boolean} [validator=() => true] A function to validate the input
 * @property {string} [validationErrorMessage='Invalid input'] The error message to display if the input is invalid
 * @property {EasyCLITheme} [theme=null] The theme to use
 * @property {DisplayOptions} [promptTheme='default'] The theme to use for the prompt
 *
 * @example
 * ```typescript
 * {
 *  defaultSelected: ['A', 'B'],
 *  validator: input => input.length > 0,
 *  validationErrorMessage: 'You must select at least one choice',
 *  theme: new EasyCLITheme(),
 *  promptTheme: 'info',
 * }
 * ```
 */
export type PromptMultipleChoiceOptions = {
    defaultSelected?: string[];
    validator?: (input: string[]) => boolean;
    validationErrorMessage?: string;
    theme?: null | EasyCLITheme;
    promptTheme?: DisplayOptions;
};
/**
 * Prompts the user to select multiple choices from a list of choices, if the input is invalid, it will prompt the user again for a valid input
 *
 * @param {string} prompt The prompt to display to the user
 * @param {string[]} choices The choices to display to the user
 * @param {PromptMultipleChoiceOptions} options  The options for the prompt
 *
 * @returns {Promise<string[]>} The validated choices the user selected
 *
 * @example
 * ```typescript
 * // Prompt the user to select a choice
 * const choices = await promptMultipleChoice('Select a choice', ['A', 'B', 'C']);
 * console.log(choices);
 *
 * // Prompt the user to select multiple choices with a default selection
 * const choices = await promptMultipleChoice('Select a choice', ['A', 'B', 'C'], {
 *  defaultSelected: ['A', 'B'],
 * validator: (input) => input.length > 0,
 * validationErrorMessage: 'You must select at least one choice',
 * });
 * console.log(choices);
 *
 * // Prompt the user to select a choice using a custom theme
 * const choices = await promptMultipleChoice('Select a choice', ['A', 'B', 'C'], {
 * theme: new EasyCLITheme(),
 * promptTheme: 'info',
 * });
 * console.log(choices);
 *
 * // Prompt the user to select a choice using a custom displaying the choices with a theme
 * const theme = new EasyCLITheme();
 * const choices = await promptMultipleChoice('Select a choice', [
 *   theme.formattedString('A', 'info'),
 *   theme.formattedString('B', 'warn'),
 *   theme.formattedString('C', 'error')
 * ]);
 * console.log(choices);
 * ```
 *
 */
export declare const promptMultipleChoice: (prompt: string, choices: string[], { defaultSelected, validator, validationErrorMessage, theme, promptTheme, }?: PromptMultipleChoiceOptions) => Promise<any>;