Package Exports

@inquirer/editor
@inquirer/editor/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@inquirer/editor) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

`@inquirer/editor`

Prompt that'll open the user preferred editor with default content and allow for a convenient multi-line input controlled through the command line.

Installation

npm install @inquirer/editor

yarn add @inquirer/editor

Usage

import editor from '@inquirer/editor';

const answer = await editor({
  message: 'Enter a description'
});

Options

Property	Type	Required	Description
message	`string`	yes	The question to ask
default	`string`	no	Default value which will automatically be present in the editor
validate	`string => boolean \| string \| Promise<string \| boolean>`	no	On submit, validate the content. When returning a string, it'll be used as the error message displayed to the user. Note: returning a rejected promise, we'll assume a code error happened and crash.
postfix	`string`	no (default to `.txt`)	The postfix of the file being edited. Adding this will add color highlighting to the file content in most editors.

@inquirer/editor