-## Readline
+# Readline
To use this module, do `require('readline')`. Readline allows reading of a
stream (such as STDIN) on a line-by-line basis.
i.pause();
});
-### rl.createInterface(input, output, completer)
+## rl.createInterface(input, output, completer)
Takes two streams and creates a readline interface. The `completer` function
is used for autocompletion. When given a substring, it returns `[[substr1,
var readline = require('readline'),
rl = readline.createInterface(process.stdin, process.stdout);
+## Class: Interface
+
+The class that represents a readline interface with a stdin and stdout
+stream.
+
### rl.setPrompt(prompt, length)
Sets the prompt, for example when you run `node` on the command line, you see
This will also resume the `in` stream used with `createInterface` if it has
been paused.
-<!-- ### rl.getColumns() Not available? -->
-
### rl.question(query, callback)
Prepends the prompt with `query` and invokes `callback` with the user's