Node.js writeStream.clearLine() 方法介绍

在 Node.js 中，writeStream.clearLine() 方法用于清除当前行。该方法是一个来自核心模块 readline 的方法，可以通过 process.stdout 或任何继承自 Writable 类的流进行调用。

语法

writeStream.clearLine(direction: number, callback?: () => void): boolean

参数

• direction：数字类型，表示清除的方向，可选值为 -1 或 1，其中 -1 表示清除从鼠标光标位置到行首的内容，1 表示清除从鼠标光标位置到行尾的内容。默认为 0，表示清除整行内容。
• callback：回调函数，可选参数。在清除完成后执行的回调函数。

返回值

返回值是一个布尔值，表示该方法是否成功执行。如果清除成功，则返回 true，否则返回 false。

示例

以下示例演示了如何使用 writeStream.clearLine() 方法。

const fs = require('fs');

const writeStream = fs.createWriteStream('demo.txt');

// 输出信息
writeStream.write('Hello World!\n');

// 暂停 1 秒后清除上一行
setTimeout(() => {
  // 清除当前行
  writeStream.clearLine(0);
  // 光标移到行首
  writeStream.cursorTo(0);
  // 再输出一条新信息
  writeStream.write('Node.js is awesome!');
}, 1000);

在上面的示例中，我们首先创建了一个写入流 writeStream，然后使用 writeStream.write() 方法输出了一条带换行符的信息。接下来，我们通过定时器延迟 1 秒后，在新的一行上输出了另一条信息。在这之前，我们使用 writeStream.clearLine(0) 方法清除了上一行的内容，然后使用 writeStream.cursorTo(0) 方法将光标移动到新行的开头，最后使用 writeStream.write() 方法输出了新的信息。

注意事项

• writeStream.clearLine() 方法只能清除当前行的内容，如果需要清除多行的内容，需要在循环中多次执行该方法。
• 该方法不会改变 writeStream 上当前位置的指针，因此在调用该方法后，需要使用 writeStream.cursorTo() 方法将光标移动到新的位置，再使用 writeStream.write() 方法输出新的内容。