Trait/Object

io.scalajs.nodejs.repl

REPLServer

Related Docs: object REPLServer | package repl

Permalink

trait REPLServer extends Object with IEventEmitter with Interface

REPL Server

Annotations
@RawJSType() @native()
Linear Supertypes
Interface, IEventEmitter, Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. REPLServer
  2. Interface
  3. IEventEmitter
  4. Object
  5. Any
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def addListener(eventName: String, listener: Function): REPLServer.this.type

    Permalink

    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

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def close(): Unit

    Permalink

    Closes the Interface instance, relinquishing control on the input and output streams.

    Closes the Interface instance, relinquishing control on the input and output streams. The 'close' event will also be emitted.

    Definition Classes
    Interface
    Example:
    1. rl.close()

  8. val context: Dynamic

    Permalink

    The REPL's context

  9. def defineCommand(keyword: String, cmd: Any): Unit

    Permalink

    Makes a command available in the REPL.

    Makes a command available in the REPL. The command is invoked by typing a . followed by the keyword. The cmd is an object with the following values:

    • help - help text to be displayed when .help is entered (Optional).
    • action - a function to execute, potentially taking in a string argument, when the command is invoked, bound to the REPLServer instance (Required).

    If a function is provided instead of an object for cmd, it is treated as the action.

    Example:
    1. replServer.defineCommand(keyword, cmd)

  10. def displayPrompt(): Unit

    Permalink

    Like readline.prompt except also adding indents with ellipses when inside blocks.

    Like readline.prompt except also adding indents with ellipses when inside blocks. The preserveCursor argument is passed to readline.prompt. This is used primarily with defineCommand. It's also used internally to render each prompt line.

    Example:
    1. replServer.displayPrompt([preserveCursor])

    See also

    prompt()

  11. def displayPrompt(preserveCursor: Boolean): Unit

    Permalink

    Like readline.prompt except also adding indents with ellipses when inside blocks.

    Like readline.prompt except also adding indents with ellipses when inside blocks. The preserveCursor argument is passed to readline.prompt. This is used primarily with defineCommand. It's also used internally to render each prompt line.

    Example:
    1. replServer.displayPrompt([preserveCursor])

    See also

    prompt()

  12. var domain: String

    Permalink
    Definition Classes
    IEventEmitter
  13. def emit(name: String, args: Any*): Any

    Permalink

    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][, ...])

  14. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  18. def getMaxListeners(): Int

    Permalink

    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()

  19. def hasOwnProperty(v: String): Boolean

    Permalink
    Definition Classes
    Object
  20. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  21. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  22. def isPrototypeOf(v: Object): Boolean

    Permalink
    Definition Classes
    Object
  23. def listenerCount(eventName: String): Int

    Permalink

    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)

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

    Permalink

    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)

  25. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  26. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  27. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  28. def on(eventName: String, listener: Function): REPLServer.this.type

    Permalink

    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)

  29. def once(eventName: String, listener: Function): REPLServer.this.type

    Permalink

    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)

  30. def pause(): Unit

    Permalink

    Pauses the readline input stream, allowing it to be resumed later if needed.

    Pauses the readline input stream, allowing it to be resumed later if needed. Note: that this doesn't immediately pause the stream of events. Several events may be emitted after calling pause, including line.

    Definition Classes
    Interface
    Example:
    1. rl.pause()

  31. def prompt(): Unit

    Permalink

    Readies readline for input from the user, putting the current setPrompt options on a new line, giving the user a new spot to write.

    Readies readline for input from the user, putting the current setPrompt options on a new line, giving the user a new spot to write. Set preserveCursor to true to prevent the cursor placement being reset to 0. This will also resume the input stream used with createInterface if it has been paused. If output is set to null or undefined when calling createInterface, the prompt is not written.

    Definition Classes
    Interface
    Example:
    1. rl.prompt([preserveCursor])

  32. def prompt(preserveCursor: Boolean): Unit

    Permalink

    Readies readline for input from the user, putting the current setPrompt options on a new line, giving the user a new spot to write.

    Readies readline for input from the user, putting the current setPrompt options on a new line, giving the user a new spot to write. Set preserveCursor to true to prevent the cursor placement being reset to 0. This will also resume the input stream used with createInterface if it has been paused. If output is set to null or undefined when calling createInterface, the prompt is not written.

    Definition Classes
    Interface
    Example:
    1. rl.prompt([preserveCursor])

  33. def propertyIsEnumerable(v: String): Boolean

    Permalink
    Definition Classes
    Object
  34. def question(query: String, callback: Function): Unit

    Permalink

    Prepends the prompt with query and invokes callback with the user's response.

    Prepends the prompt with query and invokes callback with the user's response. Displays the query to the user, and then invokes callback with the user's response after it has been typed. This will also resume the input stream used with createInterface if it has been paused. If output is set to null or undefined when calling createInterface, nothing is displayed.

    Definition Classes
    Interface
    Example:
    1. rl.question(query, callback)

  35. def removeAllListeners(): REPLServer.this.type

    Permalink

    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])

  36. def removeAllListeners(eventName: String): REPLServer.this.type

    Permalink

    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])

  37. def removeListener(eventName: String, listener: Function): REPLServer.this.type

    Permalink

    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)

  38. def resume(): Unit

    Permalink

    Resumes the readline input stream.

    Resumes the readline input stream.

    Definition Classes
    Interface
    Example:
    1. rl.resume()

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

    Permalink

    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. def setPrompt(prompt: String): Unit

    Permalink

    Sets the prompt, for example when you run node on the command line, you see > , which is Node.js's prompt.

    Sets the prompt, for example when you run node on the command line, you see > , which is Node.js's prompt.

    Definition Classes
    Interface
    Example:
    1. rl.setPrompt(prompt)

  41. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  42. def toLocaleString(): String

    Permalink
    Definition Classes
    Object
  43. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  44. var usingDomains: Boolean

    Permalink
    Definition Classes
    IEventEmitter
  45. def valueOf(): Any

    Permalink
    Definition Classes
    Object
  46. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  47. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  48. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  49. def write(data: String): Unit

    Permalink

    Writes data to output stream, unless output is set to null or undefined when calling createInterface.

    Writes data to output stream, unless output is set to null or undefined when calling createInterface. key is an object literal to represent a key sequence; available if the terminal is a TTY. This will also resume the input stream if it has been paused.

    Definition Classes
    Interface
    Example:
    1. rl.write(data[, key])

  50. def write(data: String, key: Any): Unit

    Permalink

    Writes data to output stream, unless output is set to null or undefined when calling createInterface.

    Writes data to output stream, unless output is set to null or undefined when calling createInterface. key is an object literal to represent a key sequence; available if the terminal is a TTY. This will also resume the input stream if it has been paused.

    Definition Classes
    Interface
    Example:
    1. rl.write(data[, key])

Inherited from Interface

Inherited from IEventEmitter

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped