To use this module, do require('readline'). Readline allows reading of a\nstream (such as STDIN) on a line-by-line basis.\n\n
Note that once you've invoked this module, your node program will not\nterminate until you've paused the interface. Here's how to allow your\nprogram to gracefully pause:\n\n
\nvar rl = require('readline');\n\nvar i = rl.createInterface(process.stdin, process.stdout, null);\ni.question("What do you think of node.js?", function(answer) {\n // TODO: Log the answer in a database\n console.log("Thank you for your valuable feedback.");\n\n i.pause();\n});Takes two streams and creates a readline interface. The completer function\nis used for autocompletion. When given a substring, it returns [[substr1,\nsubstr2, ...], originalsubstring].\n\n
Also completer can be run in async mode if it accepts two arguments:\n\n
function completer(linePartial, callback) {\n callback(null, [['123'], linePartial]);\n }\n\n
\ncreateInterface is commonly used with process.stdin and\nprocess.stdout in order to accept user input:\n\n
var readline = require('readline'),\n rl = readline.createInterface(process.stdin, process.stdout);The class that represents a readline interface with a stdin and stdout\nstream.\n\n
\n", "methods": [ { "textRaw": "rl.setPrompt(prompt, length)", "type": "method", "name": "setPrompt", "desc": "Sets the prompt, for example when you run node on the command line, you see\n> , which is node's prompt.\n\n
Readies readline for input from the user, putting the current setPrompt\noptions on a new line, giving the user a new spot to write.\n\n
This will also resume the in stream used with createInterface if it has\nbeen paused.\n\n
Prepends the prompt with query and invokes callback with the user's\nresponse. Displays the query to the user, and then invokes callback with the\nuser's response after it has been typed.\n\n
This will also resume the in stream used with createInterface if it has\nbeen paused.\n\n
Example usage:\n\n
\ninterface.question('What is your favorite food?', function(answer) {\n console.log('Oh, so your favorite food is ' + answer);\n});Pauses the readline in stream, allowing it to be resumed later if needed.\n\n
Resumes the readline in stream.\n\n
Writes to tty.\n\n
\nThis will also resume the in stream used with createInterface if it has\nbeen paused.\n\n
function (line) {}\n\n
Emitted whenever the in stream receives a \\n, usually received when the\nuser hits enter, or return. This is a good hook to listen for user input.\n\n
Example of listening for line:\n\n
rl.on('line', function (cmd) {\n console.log('You just typed: '+cmd);\n});function () {}\n\n
Emitted whenever the in stream is paused or receives ^D, respectively known\nas EOT. This event is also called if there is no SIGINT event listener\npresent when the in stream receives a ^C, respectively known as SIGINT.\n\n
Also emitted whenever the in stream is not paused and receives the SIGCONT\nevent. (See events SIGTSTP and SIGCONT)\n\n
Example of listening for pause:\n\n
rl.on('pause', function() {\n console.log('Readline paused.');\n});function () {}\n\n
Emitted whenever the in stream is resumed.\n\n
Example of listening for resume:\n\n
rl.on('resume', function() {\n console.log('Readline resumed.');\n});function () {}\n\n
Emitted whenever the in stream receives a ^C, respectively known as\nSIGINT. If there is no SIGINT event listener present when the in stream\nreceives a SIGINT, pause will be triggered.\n\n
Example of listening for SIGINT:\n\n
rl.on('SIGINT', function() {\n rl.question('Are you sure you want to exit?', function(answer) {\n if (answer.match(/^y(es)?$/i)) rl.pause();\n });\n});function () {}\n\n
This does not work on Windows.\n\n
\nEmitted whenever the in stream receives a ^Z, respectively known as\nSIGTSTP. If there is no SIGTSTP event listener present when the in stream\nreceives a SIGTSTP, the program will be sent to the background.\n\n
When the program is resumed with fg, the pause and SIGCONT events will be\nemitted. You can use either to resume the stream.\n\n
The pause and SIGCONT events will not be triggered if the stream was paused\nbefore the program was sent to the background.\n\n
Example of listening for SIGTSTP:\n\n
rl.on('SIGTSTP', function() {\n // This will override SIGTSTP and prevent the program from going to the\n // background.\n console.log('Caught SIGTSTP.');\n});function () {}\n\n
This does not work on Windows.\n\n
\nEmitted whenever the in stream is sent to the background with ^Z,\nrespectively known as SIGTSTP, and then continued with fg. This event only\nemits if the stream was not paused before sending the program to the\nbackground.\n\n
Example of listening for SIGCONT:\n\n
rl.on('SIGCONT', function() {\n // `prompt` will automatically resume the stream\n rl.prompt();\n});Here's an example of how to use all these together to craft a tiny command\nline interface:\n\n
\nvar readline = require('readline'),\n rl = readline.createInterface(process.stdin, process.stdout);\n\nrl.setPrompt('OHAI> ');\nrl.prompt();\n\nrl.on('line', function(line) {\n switch(line.trim()) {\n case 'hello':\n console.log('world!');\n break;\n default:\n console.log('Say what? I might have heard `' + line.trim() + '`');\n break;\n }\n rl.prompt();\n}).on('pause', function() {\n console.log('Have a great day!');\n process.exit(0);\n});