Interface RenderConfirmationPromptOptions

interface RenderConfirmationPromptOptions {
    abortSignal?: AbortSignal;
    cancellationMessage?: string;
    confirmationMessage?: string;
    defaultValue?: boolean;
    infoMessage?: {
        body: TokenItem;
        title: {
            color?: LiteralUnion<(keyof ForegroundColor), string>;
            text: TokenItem<string | CommandToken | CharToken | SubduedToken | FilePathToken | BoldToken | InfoToken | WarnToken | ErrorToken>;
        };
    };
    infoTable?: {
        [header: string]: Items;
    } | InfoTableSection[];
    message: Message;
    renderOptions?: RenderOptions;
}

Hierarchy

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

Properties

abortSignal? cancellationMessage? confirmationMessage? defaultValue? infoMessage? infoTable? message renderOptions?

Properties

Optional abortSignal

abortSignal?: AbortSignal

Optional cancellationMessage

cancellationMessage?: string

Optional confirmationMessage

confirmationMessage?: string

Optional defaultValue

defaultValue?: boolean

Optional infoMessage

infoMessage?: {
    body: TokenItem;
    title: {
        color?: LiteralUnion<(keyof ForegroundColor), string>;
        text: TokenItem<string | CommandToken | CharToken | SubduedToken | FilePathToken | BoldToken | InfoToken | WarnToken | ErrorToken>;
    };
}

Type declaration

  • body: TokenItem
  • title: {
        color?: LiteralUnion<(keyof ForegroundColor), string>;
        text: TokenItem<string | CommandToken | CharToken | SubduedToken | FilePathToken | BoldToken | InfoToken | WarnToken | ErrorToken>;
    }
    • Optional color?: LiteralUnion<(keyof ForegroundColor), string>
    • text: TokenItem<string | CommandToken | CharToken | SubduedToken | FilePathToken | BoldToken | InfoToken | WarnToken | ErrorToken>

Optional infoTable

infoTable?: {
    [header: string]: Items;
} | InfoTableSection[]

Type declaration

  • [header: string]: Items

message

message: Message

Optional renderOptions

renderOptions?: RenderOptions

Settings

Member Visibility

Theme

On This Page

abortSignalcancellationMessageconfirmationMessagedefaultValueinfoMessageinfoTablemessagerenderOptions