confirmation

A confirmation window for Node scripts.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
confirmation
11500.0.54 years ago4 years agoMinified + gzip package size for confirmation in KB

Readme

⁉️ confirmation
A simple Node tool to have Browser's confirm popup on your CLI.
confirmation

Installation

yarn add confirmation

Usage

In an async function just call await confirmation.
if (await confirmation('Are you sure?')) {
  console.log('Yay!');
} else {
  console.log('Oops!');
}

API

await confirmation(message) : bool

Shows a message and OK and Cancel buttons.
Example:
const result = await confirmation('You will delete your items, are you sure?')

await confirmation(title, message) : bool

Shows a message with a title and OK and Cancel buttons.
Example:
const result = await confirmation('Warning', 'You will delete your items, are you sure?')

await confirmation(title, message, ok, cancel) : bool

Shows a message with a title and custom OK and custom Cancel buttons.
Example:
const result = await confirmation(
  'Warning',
  'You will delete your items, are you sure?',
  'I am sure',
  'No!'
)

The Key bindings

The Y for OK and N for Cancel are the default key bindings.
When you customize your OK and Cancel buttons, the first letter will be the key binding. If you make I am Sure instead of OK, you'll need to press I to confirm.

Example 1

Example:
const result = await confirmation(
  'Warning',
  'You will delete your items, are you sure?',
  '[O] OK',
  '[X] Close'
)
Keymap:
  • O to Confirm
  • X to Close

Example 2

Example:
const result = await confirmation(
  'Warnin\'',
  'Ye will scuttle yer items, are ye sure?',
  'Aye',
  'No'
)
Keymap:
  • A (Aye) to Confirm
  • N (No) to Close

License

MIT © Fatih Kadir Akin