readlineMod

object readlineMod
class Object
trait Matchable
class Any

Type members

Classlikes

@native @JSType
trait CursorPos extends StObject
Companion
object
object CursorPos
Companion
class
@JSType
trait Direction extends StObject
Companion
object
object Direction
Companion
class
@JSImport("readline", "Interface") @native @JSType
class Interface extends StObject
@native @JSType
trait Key extends StObject
Companion
object
object Key
Companion
class
@native @JSType
trait ReadLineOptions extends StObject
Companion
object
Companion
class

Types

type AsyncCompleter = Function2[String, Function2[UndefOr[Null | Error], UndefOr[CompleterResult], Unit], Unit]
type Completer = Function1[String, CompleterResult]
type CompleterResult = Tuple2[Array[String], String]

Value members

Concrete methods

@inline
def clearLine(stream: WritableStream, dir: Direction): Boolean

Clears the current line of this WriteStream in a direction identified by dir.

Clears the current line of this WriteStream in a direction identified by dir.

@inline
def clearLine(stream: WritableStream, dir: Direction, callback: Function0[Unit]): Boolean
@inline
def clearScreenDown(stream: WritableStream): Boolean

Clears this WriteStream from the current cursor down.

Clears this WriteStream from the current cursor down.

@inline
def clearScreenDown(stream: WritableStream, callback: Function0[Unit]): Boolean
@inline
@inline
def createInterface(input: ReadableStream, output: WritableStream, completer: AsyncCompleter, terminal: Boolean): Interface
@inline
@inline
def createInterface(input: ReadableStream, output: WritableStream, completer: Completer, terminal: Boolean): Interface
@inline
def createInterface(input: ReadableStream, output: WritableStream, completer: Unit, terminal: Boolean): Interface
@inline
def createInterface(input: ReadableStream, output: Unit, completer: AsyncCompleter): Interface
@inline
def createInterface(input: ReadableStream, output: Unit, completer: AsyncCompleter, terminal: Boolean): Interface
@inline
def createInterface(input: ReadableStream, output: Unit, completer: Completer): Interface
@inline
def createInterface(input: ReadableStream, output: Unit, completer: Completer, terminal: Boolean): Interface
@inline
def createInterface(input: ReadableStream, output: Unit, completer: Unit, terminal: Boolean): Interface
@inline
def cursorTo(stream: WritableStream, x: Double): Boolean

Moves this WriteStream's cursor to the specified position.

Moves this WriteStream's cursor to the specified position.

@inline
def cursorTo(stream: WritableStream, x: Double, y: Double): Boolean
@inline
def cursorTo(stream: WritableStream, x: Double, y: Double, callback: Function0[Unit]): Boolean
@inline
def cursorTo(stream: WritableStream, x: Double, y: Unit, callback: Function0[Unit]): Boolean
@inline
@inline
def emitKeypressEvents(stream: ReadableStream, readlineInterface: Interface): Unit
@inline
def moveCursor(stream: WritableStream, dx: Double, dy: Double): Boolean

Moves this WriteStream's cursor relative to its current position.

Moves this WriteStream's cursor relative to its current position.

@inline
def moveCursor(stream: WritableStream, dx: Double, dy: Double, callback: Function0[Unit]): Boolean

Concrete fields

@JSImport("readline") @native
val ^: Any