base-questions中文文档|base-questions js中文教程|解析

npm npmdoc 2年前 (2021-12-18) 438次浏览

base-questions中文文档|base-questions js中文教程|解析

安装命令:npm i base-questions

基本问题 NPM 版本 NPM 下载 构建状态

base-methods 插件,用于添加提示用户和逐个项目存储答案的方法。

您可能还对data-store感兴趣

目录

动词使用markdown-toc生成的目录

安装

使用npm安装

$ npm install --save base-questions

用法

如果有助于查看以下示例,请尝试运行实际示例

var questions = require('base-questions');
var assemble = require('assemble-core');
var store = require('base-store');
var argv = require('base-argv');
 
var app = assemble();
app.use(store());
app.use(argv());
 
var argv = app.argv(process.argv.slice(2));
app.use(questions(app, argv.options));
 
app.task('ask', function (cb) {
  app.ask(function (err, answers) {
    if (err) return cb(err);
    console.log(answers);
    cb();
  });
});
 
app.task('a', function (cb) {
  console.log('task > a!');
  cb();
});
 
app.task('b', function (cb) {
  console.log('task > b!');
  cb();
});
 
app.task('c', function (cb) {
  console.log('task > c!');
  cb();
});
 
app.task('choices', function (cb) {
  app.choices('run', ['a', 'b', 'c'], function (err, answers) {
    if (err) return cb(err);
    if (!answers.run.length) return cb();
    app.build(answers.run, cb);
  });
});
 
app.build('choices', function(err) {
  if (err) return console.log(err);
  console.log('done!');
});

应用程序接口

。确认

创建一个confirm问题。

参数

  • name {String} : 问题名称
  • msg {String} : 问题信息
  • queue {String|Array}:名称或问题名称数组。
  • options {Object|Function} : 问题选项或回调函数
  • callback {Function} : 回调函数

例子

app.confirm('file', 'Want to generate a file?');
 
// equivalent to
app.question({
  name: 'file',
  message: 'Want to generate a file?',
  type: 'confirm'
});

.选择

从数组中创建一个“选择”问题。

参数

  • name {String} : 问题名称
  • msg {String} : 问题信息
  • choices {Array} : 选择项
  • queue {String|Array}:名称或问题名称数组。
  • options {Object|Function} : 问题选项或回调函数
  • callback {Function} : 回调函数

例子

app.choices('color', 'Favorite color?', ['blue', 'orange', 'green']);
 
// or
app.choices('color', {
  message: 'Favorite color?',
  choices: ['blue', 'orange', 'green']
});
 
// or
app.choices({
  name: 'color',
  message: 'Favorite color?',
  choices: ['blue', 'orange', 'green']
});

。问题

添加.ask方法要问的问题

参数

  • name {String} : 问题名称
  • msg {String} : 问题信息
  • value {Object|String}:问题对象、消息(字符串)或选项对象。
  • locale {String}:可选择传递要使用的语言环境,否则使用默认语言环境。
  • returns {Object} : 返回this.questions对象,用于链接

例子

app.question('beverage', 'What is your favorite beverage?');
 
// or
app.question('beverage', {
  type: 'input',
  message: 'What is your favorite beverage?'
});
 
// or
app.question({
  name: 'beverage'
  type: 'input',
  message: 'What is your favorite beverage?'
});

。问

使用给定的options和回调提出一个或多个问题

参数

  • queue {String|Array}:名称或问题名称数组。
  • options {Object|Function} : 问题选项或回调函数
  • callback {Function} : 回调函数

例子

// ask all questions
app.ask(function(err, answers) {
  console.log(answers);
});
 
// ask the specified questions
app.ask(['name', 'description'], function(err, answers) {
  console.log(answers);
});

关于

相关项目

贡献

拉取请求和星星总是受欢迎的。对于错误和功能请求,请创建问题

构建文档

(本文档由verb-generate-readme动词生成器)生成,请不要直接编辑readme。对readme的任何更改必须在.verb.md中进行。)

要使用动词生成自述文件和 API 文档

$ npm install -g verb verb-generate-readme && verb

运行测试

安装开发依赖:

$ npm install -d && npm test

作者

乔恩·施林克特

执照

版权所有 © 2016,乔恩·施林克特MIT 许可发布


该文件由verb-generate-readme v0.1.31 于2016 年10 月1 日生成。

项目贡献人员列表:


极客公园 , 版权所有丨如未注明 , 均为原创丨本网站采用BY-NC-SA协议进行授权
转载请注明原文链接:base-questions中文文档|base-questions js中文教程|解析
喜欢 (0)
.excerpt .focus {display:none}