Packages

trait Readline extends Object

Readline allows of a stream (such as process.stdin) on a line-by-line basis. To use this module, do require('readline'). Note that once you've invoked this module, your Node.js program will not terminate until you've closed the interface.

Annotations
@JSType() @native()
See also

https://nodejs.org/api/readline.html

Linear Supertypes
Object, Any, AnyRef, Any
Known Subclasses
Readline
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Readline
  2. Object
  3. Any
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clearLine(stream: IWritable, dir: Int): Boolean
  6. def clearLine(stream: IWritable, dir: Int, callback: Function): Boolean

    Clears current line of given TTY stream in a specified direction.

    Clears current line of given TTY stream in a specified direction. dir should have one of following values:

    • -1 - to the left from cursor
    • 0 - the entire line
    • 1 - to the right from cursor
    Example:

    1. readline.clearLine(stream, dir)

  7. def clearScreenDown(stream: IWritable): Boolean
  8. def clearScreenDown(stream: IWritable, callback: Function): Boolean

    Clears the screen from the current position of the cursor down.

    Clears the screen from the current position of the cursor down.

    Example:

    1. readline.clearScreenDown(stream)

  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  10. def createInterface(options: ReadlineOptions): Interface

    Creates a readline Interface instance.

    Creates a readline Interface instance.

    Example:

    1. readline.createInterface(options)

  11. def cursorTo(stream: IWritable, x: Int): Unit
  12. def cursorTo(stream: IWritable, x: Int, callback: Function): Unit
  13. def cursorTo(stream: IWritable, x: Int, y: Int): Unit
  14. def cursorTo(stream: IWritable, x: Int, y: Int, callback: Function): Unit

    Move cursor to the specified position in a given TTY stream.

    Move cursor to the specified position in a given TTY stream.

    Example:

    1. readline.cursorTo(stream, x, y)

  15. def emitKeypressEvents(stream: IReadable): Unit
  16. def emitKeypressEvents(stream: IReadable, interface: Interface): Unit
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  19. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. def getPrompt(): String
  21. def hasOwnProperty(v: String): Boolean
    Definition Classes
    Object
  22. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. def isPrototypeOf(v: Object): Boolean
    Definition Classes
    Object
  25. def moveCursor(stream: IWritable, dx: Int, dy: Int): Unit
  26. def moveCursor(stream: IWritable, dx: Int, dy: Int, callback: Function): Unit

    Move cursor relative to it's current position in a given TTY stream.

    Move cursor relative to it's current position in a given TTY stream.

    Example:

    1. readline.moveCursor(stream, dx, dy)

  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  29. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  30. def propertyIsEnumerable(v: String): Boolean
    Definition Classes
    Object
  31. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  32. def toLocaleString(): String
    Definition Classes
    Object
  33. def toString(): String
    Definition Classes
    AnyRef → Any
  34. def valueOf(): Any
    Definition Classes
    Object
  35. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  36. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  37. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped