npm 包 promise-readline 使用教程

引言

在前端开发中,经常需要获取用户的输入,而 Node.js 提供了一种比较方便的方法——使用 readline 模块。但是 readline 模块返回的都是回调函数,不够方便。

----- -------- - --------------------
----- -- - --------------------------
    ------ --------------
    ------- --------------
---

----------------------- ------ -- -
    ----------------- - ------
    -----------
---

为了更加方便地使用 readline,可以使用 npm 包 promise-readline。

安装

使用 npm 安装:

--- ------- ----------------

使用示例

promise-readline 和 readline 唯一不同的就是它封装了回调函数,改为了 Promise,使用也更加方便。下面展示了一个简单的使用示例。

----- - --------------- - - ----------------------------
------ -- -- -
    ----- -- - -----------------
        ------ --------------
        ------- --------------
    ---
    ----- ---- - ----- ------------------------
    --------------------------
    -----------
-----

输出:

-------------
--------

API

promise-readline 的 API 与 readline 类似,主要封装了 Interface 的回调函数为 Promise。

createInterface

promise-readline 的入口函数,返回一个 Interface 对象。

----- - --------------- - - ----------------------------
----- -- - -------------------------

readline 类似,options 支持以下属性:

  • input:输入流
  • output:输出流

Interface 对象

Interface 对象是 promise-readline 封装过后的对象,包含以下方法。

rl.question(query[, options])

返回一个 Promise,该 Promise 将在输入完答案后被解决。

----- - --------------- - - ----------------------------
----- -- - -----------------
    ------ --------------
    ------- --------------
---
---------------------------------- -- -
    --------------------------
    -----------
---

支持以下参数:

  • query: 一个问题,被显示给用户。 最后一个字符应该是 ?? 以提示用户提供输入。 它也可以是一个包含两个属性(key 等)的对象,以便在呈现问题时配置读取行为。
  • options
    • hideEchoBack:输入模拟。 如果设置为 true,输入将显示为星号(如密码)。 默认为 false

rl.pause()

暂停输入流。

rl.resume()

恢复输入流。

rl.clearLine()

清除当前行。

rl.clearScreenDown()

清除当前行到屏幕底部

rl.close()

关闭 Interface 实例。

结语

本文介绍了 npm 包 promise-readline 的使用和 API,相比较原生的 readline 模块,promise-readline 更加方便和易用,可以极大地提高前端开发效率。我相信通过本文的介绍,读者们都可以掌握 promise-readline 的使用方法。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/60057c5281e8991b448ebd40


猜你喜欢

  • npm包webpack-chunk-rename-plugin使用教程

    Webpack是一款高度可定制的打包工具,而npm插件包则是其拓展功能的重要支持。本篇文章将详细介绍一个npm包——webpack-chunk-rename-plugin的使用方法,帮助开发者实现代码...

    3 年前
  • npm 包 gamez 使用教程

    在前端开发中,我们经常需要使用一些已有的第三方库来提高我们的生产力。npm (Node Package Manager) 是一个非常流行的 JavaScript 包管理器,我们可以通过它来方便地安装、...

    3 年前
  • NPM 包 @ngx-gamify/quizz 使用教程

    简介 @ngx-gamify/quizz 是一个专门用于创建问答游戏的 npm 包,基于 Angular 实现。通过使用此包,开发者可以快速创建出一个带有问题和答案的游戏,并在前端展示给用户使用。

    3 年前
  • npm 包 canvas-awesome-filter 使用教程

    在前端开发中,我们常常需要对图片进行处理。虽然 Canvas 提供了很好的 API,但是要手写所有的滤镜和效果,需要大量的时间和精力。而 canvas-awesome-filter 包就是一个简单易用...

    3 年前
  • npm 包 homebridge-reos-lite 使用教程

    介绍 homebridge-reos-lite 是一个可以与 Apple HomeKit 技术框架兼容的 npm 包。它支持将 Reolink 摄像机接入到 HomeKit 中,提供一些基本的摄像机控...

    3 年前
  • npm 包 postman-collection-generator 使用教程

    简介 在前端开发中,我们经常需要对接后端 API 接口。而 Postman 是一个非常好用的云端 API 管理工具,可以让我们更快速、便捷地进行接口测试和管理。不过,在开发过程中,我们可能需要将 Po...

    3 年前
  • npm 包 browser-gimei 使用教程

    概述 browser-gimei 是一个基于 JavaScript 的 npm 包,它提供了生成日本人名、地址和电话号码等随机数据的功能,是前端开发中常用的工具之一。

    3 年前
  • npm 包 motp-cli 使用教程

    前言 在前端开发过程中,我们经常需要使用一些工具来提高开发效率和降低出错率,其中,npm 是不可或缺的一种工具。npm 管理着大量的开源模块,让我们可以轻松地调用它们,motp-cli 就是其中之一。

    3 年前
  • npm 包 @gregtyler/grunt-contrib-watch 使用教程

    什么是 grunt-contrib-watch? grunt-contrib-watch 是一个用于前端开发中的监测文件变化、自动编译和刷新浏览器的工具。它可以配合 grunt 自动化构建工具使用,也...

    3 年前
  • npm 包 generator-vueappcli 使用教程

    前言 在前端开发中,Vue.js 是一款非常流行的前端框架,本文将介绍如何使用 NPM 包 generator-vueappcli 来快速地搭建一个 Vue.js 应用。

    3 年前
  • npm 包 hyper-firenokai 使用教程

    传统的代码编辑器多少存在一些问题,例如配色方案不够好看,界面不够简洁,以及功能不够强大等。然而,随着前端技术的发展,涌现出了一些新的编辑器。其中,hyper-firenokai 就是一个非常不错的选择...

    3 年前
  • npm包json-vars使用教程

    在前端开发中,我们经常需要使用变量来控制应用程序的逻辑。在JavaScript中,我们通常使用对象或JSON来存储变量。但是,每次应用程序加载时都要手动更改JSON文件,非常麻烦。

    3 年前
  • 使用 npm 包 react-redux-socket 进行实时通信

    如果你正在构建一个基于 React 和 Redux 的 web 应用,并且需要实现实时通信,那么你可能需要使用一个称为 react-redux-socket 的 npm 包。

    3 年前
  • npm 包 angular-qlik-engine-api 使用教程

    在前端开发中,常常需要与数据交互,而与数据交互最常见的方式是通过 API。因此,许多开发者会选择使用一些库或框架来简化这个过程。angular-qlik-engine-api 就是这样一款 npm 包...

    3 年前
  • npm包homebridge-terneo使用教程

    前言 在这个物联网的时代,家庭自动化成为了一个非常炙手可热的技术,各种设备可以通过互联网来控制。而homebridge-terneo是一个npm包,可以用来控制温控器,非常适合家庭自动化。

    3 年前
  • npm 包 repparcs 使用教程

    在前端开发中,我们经常需要处理和操作字符串。而使用正则表达式可以让我们更加高效和方便地完成这些任务。而 repparcs 就是一款非常实用的 npm 包,它提供了一些常用的正则表达式规则,可以帮助我们...

    3 年前
  • npm 包 vue-offline-worker 使用教程

    简介 vue-offline-worker 是一个 Vue 插件,可以将 Vue 组件转化为离线可用的 Web Worker,并且自动处理网络断线的情况,提供离线使用的支持。

    3 年前
  • npm 包 obj-watcher-observe 使用教程

    简介 obj-watcher-observe 是一个简单易用的 JavaScript 库,用于监听 JavaScript 对象的变化。在前端开发中,我们经常需要对某些数据源进行监听,从而及时更新数据或...

    3 年前
  • npm 包 wxwork 使用教程

    前言 作为一名前端开发者,我们经常需要跟企业微信进行集成。而 wxwork 这个 npm 包可以帮助我们更快速地进行开发。本文将详细介绍 wxwork 包的使用方法及其实现原理。

    3 年前
  • npm 包 node-fpgrowth 使用教程

    在数据挖掘领域,频繁模式挖掘(Frequent Pattern Mining)是一项非常重要的任务。而在频繁模式挖掘算法中,FP-Growth算法是一种效率非常高且得到广泛应用的算法。

    3 年前

相关推荐

    暂无文章