`@inquirer/confirm`

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

Special Thanks

Graphite is the AI developer productivity platform helping teams on GitHub ship higher quality software, faster

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;
  };
};

2.5 KiB Raw Blame History

@inquirer/confirm