Node.js writeStream.moveCursor() Method

The writeStream.moveCursor() method is an inbuilt application programming interface of class WriteStream within tty module which is used to move the cursor of the write stream object relative to its current position.

Syntax:

const writeStream.moveCursor(dx, dy[, callback])

Parameters: This method takes the following parameters:

• dx: The x-axis coordinates with respect to the current coordinate.
• dy: The y-axis coordinate with respect to the current coordinate.
• callback: The callback function which executes after the operation.

Return Value: This method returns the Boolean value true if the cursor of the write stream object is moved relative to its current position.

Example 1: Filename: index.js

Javascript

// Node.js program to demonstrate the
// writeStream.moveCursor() method

// Importing dgram module
const dgram = require('dgram');

// Creating and initializing client
// and server socket
const client = dgram.createSocket("udp4");
const server = dgram.createSocket("udp4");

// Handling the message event
server.on("message", function (msg) {

    // Creating and initializing a
    // WriteStream object
    let WriteStream = process.stdout;

    // Moving cursor to with respect
    // to previous position by using
    // moveCursor() method
    const col = WriteStream.moveCursor(10, 7, () => {
    });

    // 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("cursor is moved :- ",
    0, 26, 1234, "localhost");

Output:

cursor is moved :-  true

Example 2: Filename: index.js

Javascript

// Node.js program to demonstrate the
// writeStream.moveCursor() method

// Creating and initializing a
// WriteStream object
let WriteStream = process.stdout;

// Moving cursor to with respect to
// previous position by using
// moveCursor() method
const col = WriteStream.moveCursor(10, 7, () => {
});

// Displaying the result
console.log("cursor is moved :- " + col);

Run the index.js file using the following command:

node index.js

Output:

cursor is moved :-  true

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