Packages

trait Readline extends Object with IEventEmitter

reading 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
@RawJSType() @native()
See also

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

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

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. def addListener(eventName: String, listener: Function): Readline.this.type

    Alias for emitter.on(eventName, listener).

    Alias for emitter.on(eventName, listener).

    Definition Classes
    IEventEmitter
    Example:

    1. emitter.addListener(eventName, listener)

    See also

    on()

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clearLine(stream: IWritable, dir: Int, callback: Function = js.native): 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, callback: Function = js.native): 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)

  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  9. def createInterface(options: ReadlineOptions): Interface

    Creates a readline Interface instance.

    Creates a readline Interface instance.

    Example:

    1. readline.createInterface(options)

  10. def cursorTo(stream: IWritable, x: Int): Unit
  11. def cursorTo(stream: IWritable, x: Int, callback: Function): Unit
  12. def cursorTo(stream: IWritable, x: Int, y: Int, callback: Function = js.native): 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)

  13. val domain: String
    Definition Classes
    IEventEmitter
  14. def emit(name: String, args: Any*): Boolean

    Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

    Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

    Returns true if the event had listeners, false otherwise.

    name

    the event name

    args

    the event arguments

    Definition Classes
    IEventEmitter
    Example:

    1. emitter.emit(name[, arg1][, arg2][, ...])

  15. def emitKeypressEvents(stream: IReadable, interface: Interface = js.native): Unit
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  18. def eventNames(): Array[String]
    Definition Classes
    IEventEmitter
  19. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  20. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. def getMaxListeners(): Int

    Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.

    Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.

    Definition Classes
    IEventEmitter
    Example:

    1. emitter.getMaxListeners()

    See also

    setMaxListeners()

  22. def hasOwnProperty(v: String): Boolean
    Definition Classes
    Object
  23. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. def isPrototypeOf(v: Object): Boolean
    Definition Classes
    Object
  26. def listenerCount(eventName: String): Int

    Returns the number of listeners listening to the event named eventName.

    Returns the number of listeners listening to the event named eventName.

    Definition Classes
    IEventEmitter
    Example:

    1. emitter.listenerCount(eventName)

  27. def listeners(eventName: String): Array[Function]

    Returns a copy of the array of listeners for the event named eventName.

    Returns a copy of the array of listeners for the event named eventName.

    Definition Classes
    IEventEmitter
    Example:

    1. emitter.listeners(eventName)

  28. def moveCursor(stream: IWritable, dx: Int, dy: Int, callback: Function = js.native): 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)

  29. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  30. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  31. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  32. def on(eventName: String, listener: Function): Readline.this.type

    Adds the listener function to the end of the listeners array for the event named eventName.

    Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

    Returns a reference to the EventEmitter so calls can be chained.

    Definition Classes
    IEventEmitter
    Example:

    1. emitter.on(eventName, listener)

  33. def once(eventName: String, listener: Function): Readline.this.type

    Adds a one time listener function for the event named eventName.

    Adds a one time listener function for the event named eventName. This listener is invoked only the next time eventName is triggered, after which it is removed.

    Definition Classes
    IEventEmitter
    Example:

    1. emitter.once(eventName, listener)

  34. def prependListener(eventName: String, listener: Function): Readline.this.type
    Definition Classes
    IEventEmitter
  35. def prependOnceListener(eventName: String, listener: Function): Readline.this.type
    Definition Classes
    IEventEmitter
  36. def propertyIsEnumerable(v: String): Boolean
    Definition Classes
    Object
  37. def removeAllListeners(eventName: String = js.native): Readline.this.type

    Removes all listeners, or those of the specified eventName.

    Removes all listeners, or those of the specified eventName.

    Note that it is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

    Returns a reference to the EventEmitter so calls can be chained.

    Definition Classes
    IEventEmitter
    Example:

    1. emitter.removeAllListeners([eventName])

  38. def removeListener(eventName: String, listener: Function): Readline.this.type

    Removes the specified listener from the listener array for the event named eventName.

    Removes the specified listener from the listener array for the event named eventName. removeListener will remove, at most, one instance of a listener from the listener array. If any single listener has been added multiple times to the listener array for the specified eventName, then removeListener must be called multiple times to remove each instance.

    Note that once an event has been emitted, all listeners attached to it at the time of emitting will be called in order. This implies that any removeListener() or removeAllListeners() calls after emitting and before the last listener finishes execution will not remove them from emit() in progress. Subsequent events will behave as expected.

    Definition Classes
    IEventEmitter
    Example:

    1. emitter.removeListener(eventName, listener)

  39. def setMaxListeners(n: Int): Readline.this.type

    By default EventEmitters will print a warning if more than 10 listeners are added for a particular event.

    By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. Obviously, not all events should be limited to just 10 listeners. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) for to indicate an unlimited number of listeners.

    Returns a reference to the EventEmitter so calls can be chained.

    Definition Classes
    IEventEmitter
    Example:

    1. emitter.setMaxListeners(n)

  40. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  41. def toLocaleString(): String
    Definition Classes
    Object
  42. def toString(): String
    Definition Classes
    AnyRef → Any
  43. val usingDomains: Boolean
    Definition Classes
    IEventEmitter
  44. def valueOf(): Any
    Definition Classes
    Object
  45. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  46. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  47. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from IEventEmitter

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped