bare-readline

bare-readline — Line editing for interactive CLIs with command history.

Mirrors the Node.js readline module.

npm i bare-readline

Usage

const readline = require('bare-readline')

const rl = readline.createInterface({
  input: stream,
  output: stream
})

rl.on('data', (line) => {
  console.log(line)
  rl.prompt()
}).prompt()

API

Readline

new Readline(opts?: ReadlineOptions)

Create a Readline interface over an input and output stream.

Parameters

clearLine(): string

Clear the current input line from the output and reset the line buffer and cursor, returning the cleared line.

Returns string — the input line that was cleared, before the buffer and cursor were reset.

close(): void

Stop listening for input and end the stream.

cursor: number

The current cursor position within the input line.

getPrompt(): string

Returns the current prompt string.

Returns string — the current prompt string.

input: Readable

The readable stream that keystrokes are read from.

line: string

The current, in-progress input line.

output: Writable

The writable stream that the prompt and line edits are rendered to.

prompt(): void

Render the prompt and current input line to the output.

Readline.constants: { EOL: string }

Constants used by Readline, including the end-of-line sequence.

Readline.createInterface(opts?: ReadlineOptions): Readline

Create a Readline interface over an input and output stream.

Parameters

setPrompt(prompt: string): void

Set the prompt string written before the input line.

Parameters

write(data: string): void

Write data directly to the output stream.

Parameters

Types

ReadlineOptions

interface ReadlineOptions {
  crlfDelay?: number
  input?: Readable
  output?: Writable
  prompt?: string
}

Options accepted when constructing a Readline interface.

ReadlineEvents

interface ReadlineEvents extends ReadableEvents {
  data: [line: string]
  history: [history: string[]]
  line: [line: string]
}

Events emitted by a Readline interface.

See also

• Bare modules — the full bare-* catalog.
• Bare runtime API — the runtime these modules extend.