Module: cli/input/form

input.form

Prompts the user with a form using Enquirer and returns the collected responses.

Parameters:

Name Type Description

option

Object

Configuration for the form prompt, including key, question, and field definitions.

Properties

Name Type Description

key

string

The key for the response.

question

string

The message to display to the user.

field

Array.<Object>

The list of selectable choices.

Properties

Name	Type	Description
`name`	string	The key name for the response.
`message`	string	The key of question.
`initial`	string	String placeholder.

Source: input.js, line 199

Returns:

The user's responses to the form fields.

Type:: Promise.<Object>

Example

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

let result = await input.form({
  key: 'data',
  question: 'Please provide the following information:',
  field: [
    { name: 'package', message: 'Package name', initial: 'test' },
    { name: 'version', message: 'Version', initial: '1.0.0' },
    { name: 'main', message: 'Main script', initial: 'index.js' },
    { name: 'type', message: 'Script type', initial: 'module' }
  ]
});

console.table(result.data);