inquirerjs
创始人
2024-05-30 15:21:29
0

inquirerjs

inquirerjs是一个用来实现命令行交互界面的工具集合。它帮助我们实现与用户的交互交流,比如给用户一个提醒,用户给我们一个答案,我们根据用户的答案来做一些事情,典型应用如plop等生成器工具。

npm install inquirer
var inquirer = require('inquirer')
inquirer.prompt([/*在这里配置你的问题(可以设置多个,他们将按顺序向用户提出) */
]).then(answers=>{//回掉,对用户输入的答案进行处理
})

方法

  1. inquire.prompt(questions)->promise
    启动命令行提问界面
  • questions:数组类型,每一个数组项是一个问题,这些问题将按照在数组中的顺序一次向用户提问
  • 返回一个Promise对象
  1. inquirer.registerPrompt(name,prompt)
    注册一个提问类型插件
  • name:字符串,提问类型名字,在question的type中使用。
  • prompt:对象,它自身的提问器。
  1. inuqirer.createPromptModule() -> prompt function
    创建一个包含自己的提问器模块。当你覆盖一个已有的提问类型或者添加一个新的提问类型时,如果不想影响其它依赖于inquirer的库,则可以使用此方法。
var prompt = inquirer.createPromptModule();
prompt(question).then();

对象

问题对象
问题对象是否包含与问题相关的值的散列

  • type:表示提问的类型,包括:input、confirm、list、rawlist、expand、checkbox、password、editor。
  • name:存储当前输入的值。
  • message:问题的描述。
  • default:默认值。
  • choices:列表选项,在某些type下可用,并且包含一个分隔符;
  • validate:对用户的回答进行校验
  • filter:对用户的回答进行过滤处理,返回处理后的值。
  • when:根据前面问题的回答,判断当前问题是否需要被回答。
  • pageSize:修改某些type类型下的渲染函数。
  • prefix:修改message默认前缀。
  • suffix: 修改message默认后缀。

例一 validate

const inquirer = require('inquirer')
inquirer.prompt([{type:'input',message:'请输入你姓名',name:'name',default:'lhh'},{type:'input',message:'请输入你的年龄',name:'age',default:18,validate:(val)=>{if(val>10 && val<120){return val;}else{return "年龄输入不正常"}}}
])

结果:

C:\Users\Administrator\Desktop\propt>node app.js
? 请输入你的姓名: lhh
? 请输入你的年龄: (18) 18
>> 18

例二 confirm

const inquirer = require('inquirer')
inquirer.prompt([{type:'confirm',message:'是否现在监听',name:'watch',default:true},{type:'confirm',message:'是否能看到我取决于上面是否通过?',name:'pass',suffix:'后缀',when:function(answer){  //当watch为true时才会到达这步;return answer.watch //只有return true才能进入这个confirm}}
]).then(answer=>{console.log(answer);
})

看看三种不同输入结果的不同:
在这里插入图片描述

例三:list选项组

使用键盘选择使用list,数字选择可以用rawlist;

const inquirer = require('inquirer')
inquirer.prompt([{type:'list',message:'请选择一个选项',name:'fruit',default:'Apple',prefix:'***',suffix:'^^^',choices:["Apple","pear","Banana",],filter:function(val){return val.toUpperCase();}}
]).then(answer=>{console.log(answer)
})

choices可以使用简写的.
type:expand。输入key自动拓展成value;

choices:[{key:'a',value:'apple'},{key:'b',value:'banana'},{key:'p',value:'pear'}]

例四

多选和分隔符 checkbox

const inquirer = require('inquirer')
inquirer.prompt([{type:'checkbox',message:'选择一至多种颜色',name:'color',choices:[{name:'red'},new inquirer.Separator() //添加分隔符{name:'blur',},{name:'green',},{name:'pink',checked:true}new inquirer.Separator('----分隔符---‘)//自定义分隔符{name:'orange'}]}
]).then(answer=>{console.log(answer);
})

例五

密码:type:password
数字:type:Number

const inquirer = require("inquirer")
inquirer.prompt([{type:'password',message:'请输入你的密码',name:'pwd'}
]).then(answer=>{console.log(answer)
})

例六

编辑器:使用首选编辑器打开一个临时文件,用户推出编辑器后,将读取临时文件的内容。首选编辑器可以指定。

const inquirer = require('inquirer')
inquirer.prompt([{type:'editor',message:'写下你想写的东西',name:'editor'}
]).then(answer=>{console.log(answer)
})

例七

更改显示行数

const inquirer = require('inquirer')
inquirer.prompt([{type:'checkbox',message:'选择一至多种颜色'name:'color',choices:["red","blue","green","pink"],pageSize:1}
]).then(answer=>{console.log(answer)
})

除此之外inquirerjs还有很多好用的插件

相关内容

热门资讯

惠州中山公园导游词 惠州中山公园导游词范文  作为一位无私奉献的导游,通常会被要求编写导游词,导游词是导游员在游览时为口...
介绍重庆山水之都导游词 介绍重庆山水之都导游词  作为一名专门为游客提供优质服务的导游人员,时常需要编写导游词,导游词是导游...
抚顺海洋馆导游词_导游词 抚顺海洋馆导游词_导游词  作为一名默默奉献的导游,总不可避免地需要编写导游词,导游词具有极强的实用...
善卷洞的导游词 善卷洞的导游词  善卷洞位于螺岩山中,是一个古老的石灰岩溶洞,游程长约800米,全洞面积约5000平...
苏木山森林公园导游词 苏木山森林公园导游词  作为一名可信赖的导游人员,总不可避免地需要编写导游词,导游词具有形象、生动、...
小学四年级导游词 小学四年级导游词  作为一名优秀的旅游从业人员,可能需要进行导游词编写工作,导游词具有极强的实用性,...
河南信阳南湾湖景区导游词 河南信阳南湾湖景区导游词  我们今天将要游览的是信阳南湾湖风景区。南湾湖风景区位于信阳市西南郊外,距...
临安神龙川导游词 临安神龙川导游词  作为一名可信赖的导游人员,总归要编写导游词,导游词具有注重口语化、精简凝练、重点...
小三峡导游词 小三峡导游词大宁河小三峡即为著名的巫山小三峡。大宁河发源于陕西省平利县的中南山,流经重山峻岭和大小峡...
西双版纳植物园导游词 西双版纳植物园导游词  导语:西双版纳在云南省的南部,面积约2万平方公里,聚居着10多个民族,其中以...
九华山的导游词 九华山的导游词  九华山原来并不叫九华山,在唐朝的时候叫做九子山,因为九华山山峰秀丽,高出云层的山峰...
经典导游欢送词范 经典导游欢送词范范文  各位游客:  好花不常开,好景不常在,今日离别后,何日君再来?邓丽君小姐这首...
新疆吐鲁番高昌故城导游词 新疆吐鲁番高昌故城导游词范文(精选3篇)  作为一无名无私奉献的导游,总不可避免地需要编写导游词,导...
蓬莱仙洞导游词 蓬莱仙洞导游词  作为一名尽职尽责的导游,时常要开展导游词准备工作,导游词具有注重口语化、精简凝练、...
恩格贝生态旅游区导游词 恩格贝生态旅游区导游词  亲爱的朋友,您到过恩格贝吗?  恩格贝是蒙古语,意为“平安、吉祥”。恩格贝...
湖北-归元寺英文导游辞 湖北-归元寺英文导游辞 Guiyuan Temple Chinese Buddhist temple...
济南九顶塔景区导游词 济南九顶塔景区导游词  篇一:济南九顶塔景区导游词  九顶塔民族风情园位于历城区柳埠镇,距济南市区公...
桂林山水的导游词 桂林山水的导游词(通用14篇)  作为一位杰出的导游,有必要进行细致的导游词准备工作,导游词是我们引...
广西榕湖、杉湖导游词-广西导... 广西榕湖、杉湖导游词-广西导游词  作为一无名无私奉献的导游,有必要进行细致的导游词准备工作,导游词...
天津海河外滩公园的导游词 天津海河外滩公园的导游词范文  各位好,现在我们要去的是海河外滩公园,海河外滩公园是天津市海河开发中...