1.0.8 • Published 4 months ago

app-lib-progress v1.0.8

Weekly downloads
-
License
ISC
Repository
github
Last release
4 months ago

app-lib-progress

app-lib-progress

一、背景介绍

1: nodejs支持进度动态显示
2:支持有总数和扫描类型的显示

二、功能描述

1. 支持带总数和不带总数
2. 完全支持制定一
3. 支持自动结束和手动结束

三、注意事项

  • 只能直接发布 后续完善工具

四、使用案列

五、todo列表

  • 进度的打印 可以参考progress开源组件 后续有需求在添加

六、API

Progress

Kind: global class

new Progress(option)

初始化参数

ParamType
optionoobject

progress.set(key, value) ⇒ object

设置属性值

Kind: instance method of Progress
Returns: object - 框架对象

ParamTypeDescription
keystring属性值
valueany

progress.get(key) ⇒ any

获取属性

Kind: instance method of Progress
Returns: any - 属性键对应的值

ParamTypeDescription
keystring属性键

progress.count(length, data, isForce) ⇒

开始统计

Kind: instance method of Progress
Returns: 进度对象

ParamTypeDescription
lengthnum长度 相对total
dataobject自定义数据
isForceboolean是否强制执行

progress.formatStr() ⇒ string

格式化输出字段内容

Kind: instance method of Progress
Returns: string - 格式化的内容

progress.output()

输出内容

Kind: instance method of Progress

progress.over() ⇒ object

结束时是否清空输出

Kind: instance method of Progress
Returns: object - 进度对象

七、发布日志

1.0.8

4 months ago