New:Microsoft Teams Notifications Are Now Available in Socket.Learn more →
Get Started

@inquirer/confirm

Package Overview
Dependencies
Maintainers
2
Versions
127
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@inquirer/confirm

Inquirer confirm prompt

latest
Source
npmnpm
Version
6.3.3
Version published
Weekly downloads
63M
4.55%
Maintainers
2
Weekly downloads
 
Created
Source

@inquirer/confirm

Simple interactive command line prompt to gather boolean input from users.

Confirm prompt

Installation

yarnpnpm
yarn add @inquirer/prompts
pnpm add @inquirer/prompts
bundeno
bun add @inquirer/prompts
deno add npm:@inquirer/prompts
npm
npm install @inquirer/prompts
Or
yarnpnpm
yarn add @inquirer/confirm
pnpm add @inquirer/confirm
bundeno
bun add @inquirer/confirm
deno add npm:@inquirer/confirm
npm
npm install @inquirer/confirm

On Deno, prompts detect the terminal's unicode and color support from the environment, so run your script with --allow-env.

Usage

import { confirm } from '@inquirer/prompts';
// Or
// import confirm from '@inquirer/confirm';

const answer = await confirm({ message: 'Continue?' });

Options

PropertyTypeRequiredDescription
messagestringyesThe question to ask
defaultbooleannoDefault answer (true or false)
transformer(boolean) => stringnoTransform the prompt printed message to a custom string
themeSee ThemingnoCustomize look of the prompt.

Theming

You can theme a prompt by passing a theme object option. The theme object only need to includes the keys you wish to modify, we'll fallback on the defaults for the rest.

type Theme = {
  prefix: string | { idle: string; done: string };
  spinner: {
    interval: number;
    frames: string[];
  };
  keywords: {
    yes: string;
    no: string;
    error: (keywords: { yes: string; no: string }) => string;
  };
  style: {
    answer: (text: string) => string;
    message: (text: string, status: 'idle' | 'done' | 'loading') => string;
    defaultAnswer: (text: string) => string;
    confirmDefault: (text: string) => string;
  };
};

The keywords property defines the words accepted as "yes" and "no". Matching is prefix-based and case-insensitive, and the first character of each word is shown in the hint (e.g. Y/n). The matched word is also displayed once the prompt is answered.

The built-in y/n/yes/no answers are always accepted, whatever the keywords are. Unrecognized input shows the keywords.error message instead of silently falling back on the default answer.

Overriding keywords is how @inquirer/i18n localizes the prompt:

confirm({
  message: '¿Continuar?',
  theme: {
    keywords: { yes: 'Sí', no: 'No' },
  },
});

The confirmDefault style marks the character representing the default answer in the hint. By default it uppercases the character (Y/n); for scripts without case (e.g. Chinese) it highlights the character with a color instead.

License

Copyright (c) 2023 Simon Boudrias (twitter: @vaxilart)
Licensed under the MIT license.

Keywords

answer

FAQs

Package last updated on 04 Oct 2026

Related posts