Interface | /node/internal/readline/interface.mjs | std@0.164.0

Module

std/node/internal/readline/interface.mjs>Interface

Deno standard library

denoland/deno_std

emitKeypressEvents.mjs

CSI

The Standard Library has been moved to JSR. See the blog post for details.

class Interface

extends InterfaceConstructor

import { Interface } from "https://deno.land/std@0.164.0/node/internal/readline/interface.mjs";

Constructors

new

Interface(

input,

output,

completer,

terminal,

)

Properties

readonly

columns

Methods

clearLine()

close()

Closes the readline.Interface instance.

getCursorPos()

Returns the real position of the cursor in relation to the input prompt + string.

getPrompt()

Returns the current prompt used by rl.prompt().

pause()

Pauses the input stream.

prompt(preserveCursor)

Writes the configured prompt to a new line in output.

resume()

Resumes the input stream if paused.

setPrompt(prompt)

Sets the prompt written to the output.

write(d, key)

Writes either data or a key sequence identified by key to the output.

[kGetDisplayPos](str)

[kHistoryNext]()

[kHistoryPrev]()

[kInsertString](c)

[kLine]()

[kMoveCursor](dx)

[kNormalWrite](b)

[kOnLine](line)

[kQuestion](query, cb)

[kQuestionCancel]()

[kRefreshLine]()

[kSetRawMode](mode)

[kTabComplete](lastKeypressWasTab)

[kTabCompleter](lastKeypressWasTab, unnamed 1)

[kTtyWrite](s, key)

[kWordLeft]()

[kWordRight]()

[kWriteToOutput](stringToWrite)

[Symbol.asyncIterator]()

Creates an AsyncIterator object that iterates through each line in the input stream as a string.