Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@inquirer/confirm

SBoudrias75.3mMIT6.0.3TypeScript support: included

Inquirer confirm prompt

answer, answers, ask, base, cli, command, command-line, confirm, enquirer, generate, generator, hyper, input, inquire, inquirer, interface, iterm, javascript, menu, node, nodejs, prompt, promptly, prompts, question, readline, scaffold, scaffolder, scaffolding, stdin, stdout, terminal, tty, ui, yeoman, yo, zsh

readme

@inquirer/confirm

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

Confirm prompt

Installation

npm yarn 
npm install @inquirer/prompts
 
yarn add @inquirer/prompts
Or 
npm install @inquirer/confirm
 
yarn add @inquirer/confirm

Usage

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

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

Options

Property Type Required Description
message string yes The question to ask
default boolean no Default answer (true or false)
transformer (boolean) => string no Transform the prompt printed message to a custom string
theme See Theming no Customize 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[];
  };
  style: {
    answer: (text: string) => string;
    message: (text: string, status: 'idle' | 'done' | 'loading') => string;
    defaultAnswer: (text: string) => string;
  };
};

License

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