Inquirer confirm prompt
npm install @inquirer/confirm@inquirer/confirmSimple interactive command line prompt to gather boolean input from users.
| npm | yarn |
|---|---|
`` | ` |
| Or | |
` | ` |
`js
import { confirm } from '@inquirer/prompts';
// Or
// import confirm from '@inquirer/confirm';
const answer = await confirm({ message: 'Continue?' });
`
| Property | Type | Required | Description |
| ----------- | ----------------------- | -------- | ------------------------------------------------------- |
| message | string | yes | The question to ask |boolean
| default | | no | Default answer (true or false) |(boolean) => string
| transformer | | no | Transform the prompt printed message to a custom string |
| theme | See Theming | no | Customize look of the prompt. |
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.
`ts``
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;
};
};
Copyright (c) 2023 Simon Boudrias (twitter: @vaxilart)
Licensed under the MIT license.