Inquirer Confirm

import confirm from "@inquirer/confirm";

import { confirm } from "@inquirer/prompts";

const confirm = require("@inquirer/confirm");

import confirm from "@inquirer/confirm";

// Simple confirmation
const shouldContinue = await confirm({ message: "Continue?" });

// With default value
const deleteFile = await confirm({
  message: "Delete this file?",
  default: false
});

// With custom transformer
const proceed = await confirm({
  message: "Proceed with deployment?",
  transformer: (answer) => answer ? "✅ Yes" : "❌ No"
});

/**
 * Creates a confirmation prompt that captures boolean user input
 * @param config - Configuration object for the confirm prompt
 * @param context - Optional context configuration for runtime behavior
 * @returns Promise resolving to boolean user response
 */
function confirm(config: ConfirmConfig, context?: ContextOptions): Promise<boolean>;

interface ConfirmConfig {
  /** The question to ask the user */
  message: string;
  /** Default answer (true or false). Any value other than false is treated as true */
  default?: boolean;
  /** Function to transform the boolean result into a custom display string */
  transformer?: (value: boolean) => string;
  /** Theme customization object for styling the prompt */
  theme?: PartialDeep<Theme>;
}

import confirm from "@inquirer/confirm";

// Basic confirmation with default true
const answer1 = await confirm({ message: "Do you want to proceed?" });
// Displays: ? Do you want to proceed? (Y/n)

// Confirmation with default false
const answer2 = await confirm({
  message: "Delete all files?",
  default: false
});
// Displays: ? Delete all files? (y/N)

// With custom response transformation
const answer3 = await confirm({
  message: "Save changes?",
  transformer: (value) => value ? "Saved!" : "Discarded"
});
// On completion shows: ✔ Save changes? Saved! (or Discarded)

function confirm(config: ConfirmConfig, context?: ContextOptions): Promise<boolean>;

interface ContextOptions {
  /** The stdin stream (defaults to process.stdin) */
  input?: NodeJS.ReadableStream;
  /** The stdout stream (defaults to process.stdout) */
  output?: NodeJS.WritableStream;
  /** If true, clear the screen after the prompt is answered */
  clearPromptOnDone?: boolean;
  /** An AbortSignal to cancel prompts asynchronously */
  signal?: AbortSignal;
}

import confirm from "@inquirer/confirm";

const answer = await confirm(
  { message: "Deploy to production?" },
  {
    clearPromptOnDone: true,
    signal: AbortSignal.timeout(10000) // Timeout after 10 seconds
  }
);

interface Theme {
  /** Prefix shown before the message, can be string or status-specific object */
  prefix: string | Prettify<Omit<Record<Status, string>, 'loading'>>;
  /** Spinner configuration for loading states */
  spinner: {
    /** The time interval between frames, in milliseconds */
    interval: number;
    /** A list of frames to show for the spinner */
    frames: string[];
  };
  /** Styling functions for different text elements */
  style: {
    /** Style function for the final answer display */
    answer: (text: string) => string;
    /** Style function for the message text */
    message: (text: string, status: Status) => string;
    /** Style function for error messages */
    error: (text: string) => string;
    /** Style function for the default value indicator */
    defaultAnswer: (text: string) => string;
    /** Style function for help text */
    help: (text: string) => string;
    /** Style function for highlighted text */
    highlight: (text: string) => string;
    /** Style function for keyboard keys referred to in help texts */
    key: (text: string) => string;
  };
}

type Status = "idle" | "done" | "loading";

type PartialDeep<T> = T extends object
  ? {
      [P in keyof T]?: PartialDeep<T[P]>;
    }
  : T;

type Prettify<T> = {
  [K in keyof T]: T[K];
} & {};

const answer = await confirm({
  message: "Deploy to production?",
  theme: {
    prefix: "🚀",
    style: {
      answer: (text) => `>>> ${text} <<<`,
      message: (text, status) => 
        status === "done" ? `✅ ${text}` : `❓ ${text}`,
      defaultAnswer: (text) => `[${text}]`
    }
  }
});