Interface RenderConfirmationPromptOptions

interface RenderConfirmationPromptOptions {
    abortSignal?: AbortSignal;
    cancellationMessage?: string;
    confirmationMessage?: string;
    defaultValue?: boolean;
    infoMessage?: {
        body: TokenItem;
        title: {
            color?: LiteralUnion<(keyof ForegroundColor), string>;
            text: TokenItem<
                | string
                | { command: string }
                | { char: string }
                | { subdued: string }
                | { filePath: string }
                | BoldToken
                | { info: string }
                | { warn: string }
                | { error: string },
            >;
        };
    };
    infoTable?: { [header: string]: Items }
    | InfoTableSection[];
    message: Message;
    renderOptions?: RenderOptions;
}

Hierarchy

  • Pick<
        SelectPromptProps<boolean>,
        "message" | "infoTable" | "infoMessage" | "abortSignal",
    >
    • RenderConfirmationPromptOptions

Properties

abortSignal?: AbortSignal
cancellationMessage?: string
confirmationMessage?: string
defaultValue?: boolean
infoMessage?: {
    body: TokenItem;
    title: {
        color?: LiteralUnion<(keyof ForegroundColor), string>;
        text: TokenItem<
            | string
            | { command: string }
            | { char: string }
            | { subdued: string }
            | { filePath: string }
            | BoldToken
            | { info: string }
            | { warn: string }
            | { error: string },
        >;
    };
}
infoTable?: { [header: string]: Items } | InfoTableSection[]
message: Message
renderOptions?: RenderOptions