Node.js之readline模块的使用详解


Posted in Javascript onMarch 25, 2019

什么是readline

readline允许从可读流中以逐行的方式读取数据,比如process.stdin等。 在node.js命令行模式下默认引入了readline模块,但如果是使用node.js运行脚本的话,则需要自己通过require('readline')方式手动引入该模块。

怎么使用readline

创建实例

首先、创建一个接口实例,提供一个Object类型的参数。参数如下: input: 监听的可读流(必需) output: 写入readline的可写流(必需) completer: 用于 Tab 自动补全的可选函数(不常用) terminal: 如果希望 input 和 output 流像 TTY 一样对待,那么传递参数 true ,并且经由 ANSI/VT100 转码。 默认情况下检查 isTTY 是否在 output 流上实例化。(不常用) historySize: 保留行历史纪录最大值,为了禁用该值被设置为0,默认为30,只有在terminal被设置为true或通过一个内部输出检查时,这个选项才有作用,否则历史缓存机制不会初始化。(不常用)

第一种方式:只传入两个必传参数

const readLine = require('readline');
 let rl = readLine.createInterface(process.stdin, process.stdout);

第二种方式:可以传入其他非必需参数

const readLine = require('readline');
 let rl = readLine.createInterface({
  input: process.stdin,
  output: process.stdout,
  // 其他参数省略
 })

实例

const readLine = require('readline');
 let rl = readLine.createInterface({
  input: process.stdin,
  output: process.stdout,
  prompt: '> 请输入'
 })
 // 调用
 rl.prompt(); // 控制台结果显示:>请输入

注意:一旦该代码被调用,Node.js程序将不会终止知道readline接口被关闭,因为接口会在输入流中不停的等待数据。

方法

以下所有的实例均依据如下rl所创建:

const readLine = require('readline');
 let rl = readLine.createInterface({
  input: process.stdin,
  output: process.stdout
 })

1、rl.setPrompt([prompt])

设置提示符,当你使用node运行该文件,并且调用rl.prompt()时,会在终端看到你设置的提示prompt,即“> 请输入”

rl.setPrompt('> 请输入')

注意:该方法和上面的实例参数配置是一样的效果

2、rl.prompt([preserveCursor])

为用户输入准备好readline,将现有的setPrompt选项放到新的一行,让用户有一个新的地方开始输入。将preserveCursor设为true来防止光标位置被重新设定成0。   如需要换行输入,即在新的一行,输入信息,可在prompt中加入\n。

rl.prompt(); // 控制台结果显示:>请输入

3、rl.write(data[, key])

当使用readline.createInterface()创建实例时,,如果输入流为null或者undefined,则写入数据到输出流。   key是一个表示键序列的字面量对象,如果终端是TTY,则可用。

rl.write('Delete me!');
 // Simulate ctrl+u to delete the line written previously
 rl.write(null, {ctrl: true, name: 'u'});

4、rl.question(query, callback)

预先制定提示内容query,将会在用户输入被应答后,触发执行指定的回掉函数callback。

rl.question('你今年多大了?\n', function(prompt) {
  console.log('这是你输入的回答结果:' + prompt);
  rl.close();
 })

5、rl.pause()

暂停readline的输入流,可以恢复,rl.resume()、rl.write()、rl.question()和rl.prompt()均可以恢复该输入流。   调用该方法会触发pause事件。

6、rl.resume()

恢复readline的输入流。   调用该方法会触发resume事件。

7、rl.close()

关闭readline创建的实例,不控制输入输出流。   调用该方法会触发close事件。

事件

1、line事件

无论何时,在输入流接收了一个行结束符(\n, \r, 或者 \r\n)时触发,即在用户输入后,按了回车或者返回键时触发该事件。可以用来监听用户输入。

rl.on('line', function (line) {
  console.log('这是用户输入的内容:' + line);
 })

2、pause事件

输入流被暂停时触发,即调用了rl.pause(),或者没有暂停输入流,在收到SIGCONT/SIGINT,且readline.Interfacce实例上并没有注册SIGCONT/SIGINT监听器时,也会被触发,并且如果输入流在收到SIGTSIP之前就已经被暂停了,那么该事件也不会触发。

rl.on('pause', function() {
  console.log('暂停输入流...')
 })

3、resume事件

输入流重新启动时被触发,即调用了rl.resume()、或者rl.write()、rl.question()和rl.prompt()。

rl.on('resume', function() {
  console.log('恢复输入流...')
 })

4、close事件

调用rl.close()方法时会触发该事件,或者输入流接收到“结束”事件。以下的任意一种情况都会触发close事件。 一旦close事件被触发,则认为readline.Interaface实例已经终止。 1)、rl.close()方法被调用后,readline.Interaface实例便会放弃输入输出流的控制权。 2)、输入流接收到自己的“end”事件。 3)、输入流接收到-C,发送SIGINT信号,并且在readline.Interfacce实例上并没有注册SIGINT事件的监听器。 4)、输入流接收到-D,发送传输结束信号(EOF,end-of-transmission); 5)、EOT:定界符,即输入单个或多个“>”,并按下回车时。

rl.on('close', function() {
  console.log('关闭输入流...');
  process.exit(0); // 退出当前进程
 })

5、SIGCOUT(该事件在window系统上不起作用)

当使用-Z将Node.js进程移动到后台时,SIGCONT事件将会被触发。然后可以使用 fg(1) 命令将它移动到前台。   如果输入流在收到SIGTSIP之前就已经被暂停了,那么该事件就不会触发。

6、SIGINT

当输入流收到-C命令时,我们熟知的SIGINT事件就会被触发。如果当时并没有注册任何SIGINT事件监听器,那么当输入流接收到SIGINT信号时,'pause'事件和'close'事件均会被触发。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Javascript 相关文章推荐
自己写的兼容ie和ff的在线文本编辑器类似ewebeditor
Dec 12 Javascript
input输入框的自动匹配(原生代码)
Mar 19 Javascript
JQUERY 获取IFrame中对象及获取其父窗口中对象示例
Aug 19 Javascript
js setTimeout opener的用法示例详解
Oct 23 Javascript
JS小游戏之象棋暗棋源码详解
Sep 25 Javascript
微信小程序开发之圆形菜单 仿建行圆形菜单实例
Dec 12 Javascript
web前端vue之vuex单独一文件使用方式实例详解
Jan 11 Javascript
JS中Map和ForEach的区别
Feb 05 Javascript
简化vuex的状态管理方案的方法
Jun 02 Javascript
浅谈HTTP 缓存的那些事儿
Oct 17 Javascript
Vue3 中的数据侦测的实现
Oct 09 Javascript
react-router-dom 嵌套路由的实现
May 02 Javascript
Javascript的this详解
Mar 23 #Javascript
如何在Angular应用中创建包含组件方法示例
Mar 23 #Javascript
vue中组件的3种使用方式详解
Mar 23 #Javascript
ES6入门教程之Array.from()方法
Mar 23 #Javascript
setTimeout与setInterval的区别浅析
Mar 23 #Javascript
如何通过setTimeout理解JS运行机制详解
Mar 23 #Javascript
vue中axios请求的封装实例代码
Mar 23 #Javascript
You might like
PHP中MD5函数使用实例代码
2008/06/07 PHP
分享一个PHP数据流应用的简单例子
2012/06/01 PHP
shell脚本作为保证PHP脚本不挂掉的守护进程实例分享
2013/07/15 PHP
php根据操作系统转换文件名大小写的方法
2014/02/24 PHP
php替换字符串中间字符为省略号的方法
2015/05/04 PHP
遍历echsop的region表形成缓存的程序实例代码
2016/11/01 PHP
php+redis在实际项目中HTTP 500: Internal Server Error故障排除
2017/02/05 PHP
php 字符串中是否包含指定字符串的多种方法
2018/04/12 PHP
thinkphp5框架路由原理与用法详解
2020/02/11 PHP
PHP中->和=>的含义及使用示例解析
2020/08/06 PHP
用javascript做拖动布局的思路
2008/05/31 Javascript
javascript div 遮罩层封锁整个页面
2009/07/10 Javascript
jquery JSON的解析方式
2009/07/25 Javascript
JavaScript 常用函数
2009/12/30 Javascript
jQuery function的正确书写方法
2013/08/02 Javascript
jquery链式操作的正确使用方法
2014/01/06 Javascript
移动设备web开发首选框架:zeptojs介绍
2015/01/29 Javascript
JavaScript中property和attribute的区别详细介绍
2015/03/03 Javascript
JavaScript实现的简单幂函数实例
2015/04/17 Javascript
JavaScript中的call和apply的用途以及区别
2017/01/11 Javascript
JavaScript 正则命名分组【推荐】
2018/06/07 Javascript
详解mpvue scroll-view自动回弹bug解决方案
2018/10/01 Javascript
JavaScript遍历数组的方法代码实例
2020/01/14 Javascript
Python中的filter()函数的用法
2015/04/27 Python
Python2.7读取PDF文件的方法示例
2017/07/13 Python
Python3学习urllib的使用方法示例
2017/11/29 Python
Python实现控制台中的进度条功能代码
2017/12/22 Python
python的继承知识点总结
2018/12/10 Python
python+os根据文件名自动生成文本
2019/03/21 Python
django一对多模型以及如何在前端实现详解
2019/07/24 Python
对于Python深浅拷贝的理解
2019/07/29 Python
Python+Pyqt实现简单GUI电子时钟
2021/02/22 Python
追悼会上的答谢词
2014/01/10 职场文书
市优秀教师事迹材料
2014/02/05 职场文书
2015年乡镇食品安全工作总结
2015/10/22 职场文书
React中的Context应用场景分析
2021/06/11 Javascript