Interface

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): Interface.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 clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

7. def close(): Unit

   

   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.

   Example:

   1. rl.close()

8. var domain: String

   

   Definition Classes

   IEventEmitter

9. def emit(name: String, args: Any*): Any

   

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

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

    

    Definition Classes

    AnyRef

11. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

12. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

13. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

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

15. def hasOwnProperty(v: String): Boolean

    

    Definition Classes

    Object

16. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

17. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

18. def isPrototypeOf(v: Object): Boolean

    

    Definition Classes

    Object

19. 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)

20. 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)

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

    

    Definition Classes

    AnyRef

22. final def notify(): Unit

    

    Definition Classes

    AnyRef

23. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

24. def on(eventName: String, listener: Function): Interface.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)

25. def once(eventName: String, listener: Function): Interface.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)

26. def pause(): Unit

    

    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.

    Example:

    1. rl.pause()

27. def prompt(): Unit

    

    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.

    Example:

    1. rl.prompt([preserveCursor])

28. def prompt(preserveCursor: Boolean): Unit

    

    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.

    Example:

    1. rl.prompt([preserveCursor])

29. def propertyIsEnumerable(v: String): Boolean

    

    Definition Classes

    Object

30. def question(query: String, callback: Function): Unit

    

    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.

    Example:

    1. rl.question(query, callback)

31. def removeAllListeners(): Interface.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])

32. def removeAllListeners(eventName: String): Interface.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])

33. def removeListener(eventName: String, listener: Function): Interface.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)

34. def resume(): Unit

    

    Resumes the readline input stream.

    Resumes the readline input stream.

    Example:

    1. rl.resume()

35. def setMaxListeners(n: Int): Interface.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)

36. def setPrompt(prompt: String): Unit

    

    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.

    Example:

    1. rl.setPrompt(prompt)

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

    

    Definition Classes

    AnyRef

38. def toLocaleString(): String

    

    Definition Classes

    Object

39. def toString(): String

    

    Definition Classes

    AnyRef → Any

40. var usingDomains: Boolean

    

    Definition Classes

    IEventEmitter

41. def valueOf(): Any

    

    Definition Classes

    Object

42. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

43. final def wait(arg0: Long, arg1: Int): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

44. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

45. def write(data: String): Unit

    

    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.

    Example:

    1. rl.write(data[, key])

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

    

    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.

    Example:

    1. rl.write(data[, key])