Module: cli/input/toggle

input.toggle

Prompts the user with a toggle question.

Parameters:

Name Type Description

option

Object

Contains the key and question for the prompt.

Properties

Name	Type	Description
`key`	string	The key for the response.
`question`	string	The message to display to the user.
`enable`	string	Placeholder for boolean true.
`disable`	string	Placeholder for boolean false.

Source: input.js, line 130

Returns:

The user's response.

Type:: Promise.<Object>

Example

import { input } from "@jlongyam/cli";

let result = await input.toggle({
  key: 'toggle',
  question: 'switch option',
  enable: 'on',
  disable: 'off'
});

console.log(result.toggle)