github:https://github.com/sindresorhus/ora
ora6.0以上版本不支持require方式引入,如果在node中使用,需要使用5.0版本
1、ora(options)
text:String
//三种方式传递参数
const ora = require('ora')
//第一种
const spinner = ora({
text:'start',
prefixText:'string value before start',
}).start()
//第二种
const spinner = ora('start').start();
//第三种
const spinner = ora().start;
spinner.text = 'start'
//第四种
const spinner = ora({
prefixText:'string value before start',
}).start('start')
prefixText:String
如果该值不是字符串,则显示为空
/**
该值会展示在text的值的前方
只有两种赋值方式
*/
const spinner = ora(
{
prefixText:'start',
}
).start()
//或者
spinner.prefixText='start'
//当然也可以用方法返回的方式
const spinner = ora(
{
prefixText:(() => {return 'start'})(),//箭头函数
}
).start()
const spinner = ora(
{
prefixText:function(){return 'start'}()//非箭头函数
}
).start()
spinner:String
windows上看不出效果,因为spinner的值一直使用的是line
//依然可以通过options传参,也可以直接赋值
const spinner = ora(
{
prefixText : (() => {return 1})(),
spinner:'dots',
}
).start();
//或者
spinner.spinner = 'line2'
color:String
//改变加载图标的颜色
const spinner = ora(
{
prefixText : (() => {return 'start'})(),
text:'hello ora',
color:'blue',
}
).start();
//或者
spinner.color = 'red'
hideCursor:Boolean
默认值是true,隐藏光标
//只能通过options的方式赋值
const spinner = ora(
{
prefixText : (() => {return 'start'})(),
text:'hello ora',
color:'blue',
hideCursor:false
}
).start();
indent:Number
使用指定数量的空格缩进
//两种方式赋值均可
const spinner = ora(
{
prefixText : (() => {return 'start'})(),
text:'hello ora',
color:'blue',
indent:5
}
).start();
spinner.indent = 10
interval:Number
加载图标旋转的间隔时间,默认是100毫秒,一般不需要设置
//也只有一种赋值方式
const spinner = ora(
{
prefixText : (() => {return 'start'})(),
text:'hello ora',
color:'blue',
interval:5000
}
).start();
设置interval后,下图红框中的图片旋转速度就会改变
stream:stream.Writable
默认是process.stderr,可以设置为process.stdout
//只有一种赋值方式
const spinner = ora(
{
prefixText : (() => {return 'start'})(),
text:'hello ora',
color:'blue',
stream:process.stderr
}
).start();
isEnable:Boolean
启用/禁用,默认值是启用
//只有一种赋值方式
const spinner = ora(
{
prefixText : (() => {return 'start'})(),
text:'hello ora',
color:'blue',
isEnabled:false
}
).start();
isSilent:Boolean
默认值是false,为true是抑制所有输出,跟isEnable为false的效果差不多
//仅能通过options方式赋值
const spinner = ora(
{
prefixText : (() => {return 'start'})(),
text:'hello ora',
color:'blue',
isSilent:true
}
).start();
discardStdin:Boolean
默认值为true,丢弃stdin输入,对windows无影响