Node.js writeStream.clearLine() Method

The writeStream.clearLine() is an inbuilt application programming interface of class WriteStream within tty module which is used to clear the current line of this write stream object.

Syntax:

writeStream.clearLine(dir[, callback])

Parameters: This method takes the following argument as a parameter:

  • dir: Integer value defining the selection of line.
  • callback: Invoked once the operation completes.

Return Value: This method returns  boolean value true if the write object line is clear otherwise false.

Example 1: Filename: index.js



filter_none

edit
close

play_arrow

link
brightness_4
code

// Node.js program to demonstrate the
// writeStream.clearLine() method
  
// Importing dgram module
var dgram = require('dgram');
  
// Creating and initializing client
// and server socket
var client = dgram.createSocket("udp4");
var server = dgram.createSocket("udp4");
  
// Handling the message event
server.on("message", function (msg) {
  
  // Creating and initializing a 
  // WriteStream object
  let WriteStream = process.stdout;
  
  // Clearing the line
  // by using clearLine() API
  const col = WriteStream.clearLine();
  
  // Displaying the result
  process.stdout.write(msg + col);
  
  // Exiting process
  process.exit();
})// Binding server with port
.bind(1234, () => {
});
  
// Client sending message to server
client.send("The line is clear :-  ",
    0, 26, 1234, "localhost");

chevron_right


Output:

The line is clear :-  true

Example 2: Filename: index.js

filter_none

edit
close

play_arrow

link
brightness_4
code

// Node.js program to demonstrate the
// writeStream.clearLine() method
  
// Creating and initializing a 
// WriteStream object
let WriteStream = process.stdout;
  
// Clearing the line
// by using clearLine() API
const col = WriteStream.clearLine();
  
// Displaying the result
console.log("The line is clear :-  " + col);

chevron_right


Run the index.js file using the following command:

node index.js

Output:

The line is clear :-  true

Reference:  https://nodejs.org/dist/latest-v12.x/docs/api/tty.html#tty_writestream_clearline_dir_callback




My Personal Notes arrow_drop_up

Check out this Author's contributed articles.

If you like GeeksforGeeks and would like to contribute, you can also write an article using contribute.geeksforgeeks.org or mail your article to contribute@geeksforgeeks.org. See your article appearing on the GeeksforGeeks main page and help other Geeks.

Please Improve this article if you find anything incorrect by clicking on the "Improve Article" button below.


Article Tags :

Be the First to upvote.


Please write to us at contribute@geeksforgeeks.org to report any issue with the above content.