@buurman/sdk/lib/src/apis/prompt/PromptApi.d.ts

The buurman SDK

import { CheckboxQuestion, ChoiceOptions, ConfirmQuestion, EditorQuestion, InputQuestion, ListQuestion, NumberQuestion, PasswordQuestion, Question } from "inquirer";
export declare type OmittedQuestionProperties = "name" | "type" | "message" | "choices";
export declare type StandardPromptFunction<TQuestion extends Question, TDefaultValue> = <TValue = TDefaultValue>(message: string, options?: Omit<TQuestion, OmittedQuestionProperties>) => Promise<TValue>;
export declare type PromptFunctionWithChoices<TQuestion extends Question, TDefaultValue> = <TValue = TDefaultValue, TAnswers = {}>(message: string, choices: (ChoiceOption<TValue, TAnswers> | string)[], options?: Omit<TQuestion, OmittedQuestionProperties>) => Promise<TValue>;
export interface PromptApi {
    confirm: StandardPromptFunction<ConfirmQuestion, boolean>;
    input: StandardPromptFunction<InputQuestion, boolean>;
    number: StandardPromptFunction<NumberQuestion, boolean>;
    password: StandardPromptFunction<PasswordQuestion, boolean>;
    editor: StandardPromptFunction<EditorQuestion, boolean>;
    list: PromptFunctionWithChoices<ListQuestion, string>;
    rawlist: PromptFunctionWithChoices<ListQuestion, string>;
    checkbox<TValue = string, TAnswers = {}>(message: string, choices: (ChoiceOption<TValue, TAnswers> | string)[], options?: Omit<CheckboxQuestion, OmittedQuestionProperties> & {
        min?: number;
        max?: number;
    }): Promise<TValue[]>;
}
export declare type ChoiceOption<TValue = string, TAnswers = {}> = ChoiceOptions<TAnswers> & {
    value: TValue;
};
declare const prompt: PromptApi;
export default prompt;
//# sourceMappingURL=PromptApi.d.ts.map