_Interface
Instances of the readline.Interface
class are constructed using the readline.createInterface()
method. Every instance is associated with a single input
Readable stream and a single output
Writable stream. The output
stream is used to print prompts for user input that arrives on, and is read from, the input
stream.
Since
v0.1.104
Inheritors
Constructors
NOTE: According to the documentation:
NOTE: According to the documentation:
NOTE: According to the documentation:
Properties
Functions
Alias for emitter.on(eventName, listener)
.
events.EventEmitter
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 an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbol
s.
Returns the real position of the cursor in relation to the input prompt + string. Long input (wrapping) strings, as well as multiple line prompts are included in the calculations.
Returns the current max listener value for the EventEmitter
which is either set by emitter.setMaxListeners(n)
or defaults to {@link defaultMaxListeners}.
Returns the number of listeners listening for the event named eventName
. If listener
is provided, it will return how many times the listener is found in the list of the listeners of the event.
Returns a copy of the array of listeners for the event named eventName
.
Alias for emitter.removeListener()
.
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.
Adds the listener
function to the beginning 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.
Adds a one-timelistener
function for the event named eventName
to the beginning of the listeners array. The next time eventName
is triggered, this listener is removed, and then invoked.
The rl.question()
method displays the query
by writing it to the output
, waits for user input to be provided on input
, then invokes the callback
function passing the provided input as the first argument.
Returns a copy of the array of listeners for the event named eventName
, including any wrappers (such as those created by .once()
).
Removes all listeners, or those of the specified eventName
.
Removes the specified listener
from the listener array for the event named eventName
.
By default EventEmitter
s 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. The emitter.setMaxListeners()
method allows the limit to be modified for this specific EventEmitter
instance. The value can be set to Infinity
(or 0
) to indicate an unlimited number of listeners.
The rl.write()
method will write either data
or a key sequence identified by key
to the output
. The key
argument is supported only if output
is a TTY
text terminal. See TTY keybindings
for a list of key combinations.