@inquirer/confirm
TypeScript icon, indicating that this package has built-in type declarations

3.1.8 • Public • Published

@inquirer/confirm

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

Confirm prompt

Installation

npm install @inquirer/confirm

yarn add @inquirer/confirm

Usage

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;
  spinner: {
    interval: number;
    frames: string[];
  };
  style: {
    answer: (text: string) => string;
    message: (text: string) => string;
    defaultAnswer: (text: string) => string;
  };
};

License

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

Package Sidebar

Install

npm i @inquirer/confirm

Weekly Downloads

1,399,613

Version

3.1.8

License

MIT

Unpacked Size

9.25 kB

Total Files

8

Last publish

Collaborators

  • sboudrias
  • danielchatfield
  • mischah