Tutorials References Menu

Node.js Readline Module

❮ Built-in Modules


Example

Open a file and return the content line by line:

var readline = require('readline');
var fs = require('fs');

var myInterface = readline.createInterface({
  input: fs.createReadStream('demofile1.html')
});

var lineno = 0;
myInterface.on('line', function (line) {
  lineno++;
  console.log('Line number ' + lineno + ': ' + line);
});
Run example »

Definition and Usage

The Readline module provides a way of reading a datastream, one line at a time.


Syntax

The syntax for including the Readline module in your application:

var readline = require('readline');

Readline Properties and Methods

Method Description
clearLine() Clears the current line of the specified stream
clearScreenDown() Clears the specified stream from the current cursor down position
createInterface() Creates an Interface object
cursorTo() Moves the cursor to the specified position
emitKeypressEvents() Fires keypress events for the specified stream
moveCursor() Moves the cursor to a new position, relative to the current position

❮ Built-in Modules