|
|
5 달 전 | |
|---|---|---|
| .. | ||
| dist | 5 달 전 | |
| LICENSE | 5 달 전 | |
| README.md | 5 달 전 | |
| package.json | 5 달 전 | |
@inquirer/confirmSimple interactive command line prompt to gather boolean input from users.
53db40ca-2254-481a-a094-6597f8716e)](https://graphite.dev/?utm_source=npmjs&utm_medium=repo&utm_campaign=inquirerjs)| npm | yarn |
|---|---|
| ```sh npm install @inquirer/prompts ``` | ```sh yarn add @inquirer/prompts ``` |
| Or | |
| ```sh npm install @inquirer/confirm ``` | ```sh yarn add @inquirer/confirm ``` |
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 |
| 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. |
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;
};
};
Copyright (c) 2023 Simon Boudrias (twitter: @vaxilart)
Licensed under the MIT license.