app-lib-progress/README.md

app-lib-progress

# app-lib-progress
app-lib-progress

<!-------------------------------common start flag------------------------->
<center>
<div align="center">
  <h1>app-lib-progress</h1>
  <a href="https://img.shields.io/badge/success: https local reason - goback refresh you brower can show badge image now-brightgree" title="click can show badge">
    <img src="https://appbir.github.io/appbir-resource-statics/image/logo.png" height="60" />
  </a>
  <h1>app-lib-progress</h1>
  <a href="https://appbir/library">
    <img src="https://img.shields.io/badge/appbir-library-blue"/>
  </a>
  <a href="https://appbir/library/-/web/detail/app-lib-progress">
    <img src="https://img.shields.io/badge/npm-v1.0.8-green">
  </a>
  <a href="https://appbir">
    <img src="https://img.shields.io/badge/license-ISC-brightgree"/>
  </a>
<div>
</center>
<!-------------------------------common end flag--------------------------->

<!-------------------------------background start flag--------------------->
# 一、背景介绍
    1: nodejs支持进度动态显示
    2：支持有总数和扫描类型的显示

<!-------------------------------background end flag----------------------->

<!-------------------------------functions start flag---------------------->
# 二、功能描述
<!-------------------------------functions end flag------------------------>
    
    1. 支持带总数和不带总数
    2. 完全支持制定一
    3. 支持自动结束和手动结束


<!-------------------------------attention start flag---------------------->
# 三、注意事项
 * 只能直接发布 后续完善工具

<!-------------------------------attention end flag------------------------>

<!-------------------------------examples start flag----------------------->
# 四、使用案列
<!-------------------------------examples end flag------------------------->

<!-------------------------------todo start flag--------------------------->
# 五、todo列表
 * 进度的打印 可以参考progress开源组件  后续有需求在添加

<!-------------------------------todo end flag----------------------------->

<!-------------------------------api start flag---------------------------->
# 六、API
<a name="Progress"></a>

## Progress
**Kind**: global class  

* [Progress](#Progress)
    * [new Progress(option)](#new_Progress_new)
    * [.set(key, value)](#Progress+set) ⇒ <code>object</code>
    * [.get(key)](#Progress+get) ⇒ <code>any</code>
    * [.count(length, data, isForce)](#Progress+count) ⇒
    * [.formatStr()](#Progress+formatStr) ⇒ <code>string</code>
    * [.output()](#Progress+output)
    * [.over()](#Progress+over) ⇒ <code>object</code>

<a name="new_Progress_new"></a>

### new Progress(option)
初始化参数


| Param | Type |
| --- | --- |
| option | <code>oobject</code> | 

<a name="Progress+set"></a>

### progress.set(key, value) ⇒ <code>object</code>
设置属性值

**Kind**: instance method of [<code>Progress</code>](#Progress)  
**Returns**: <code>object</code> - 框架对象  

| Param | Type | Description |
| --- | --- | --- |
| key | <code>string</code> | 属性值 |
| value | <code>any</code> | 值 |

<a name="Progress+get"></a>

### progress.get(key) ⇒ <code>any</code>
获取属性

**Kind**: instance method of [<code>Progress</code>](#Progress)  
**Returns**: <code>any</code> - 属性键对应的值  

| Param | Type | Description |
| --- | --- | --- |
| key | <code>string</code> | 属性键 |

<a name="Progress+count"></a>

### progress.count(length, data, isForce) ⇒
开始统计

**Kind**: instance method of [<code>Progress</code>](#Progress)  
**Returns**: 进度对象  

| Param | Type | Description |
| --- | --- | --- |
| length | <code>num</code> | 长度 相对total |
| data | <code>object</code> | 自定义数据 |
| isForce | <code>boolean</code> | 是否强制执行 |

<a name="Progress+formatStr"></a>

### progress.formatStr() ⇒ <code>string</code>
格式化输出字段内容

**Kind**: instance method of [<code>Progress</code>](#Progress)  
**Returns**: <code>string</code> - 格式化的内容  
<a name="Progress+output"></a>

### progress.output()
输出内容

**Kind**: instance method of [<code>Progress</code>](#Progress)  
<a name="Progress+over"></a>

### progress.over() ⇒ <code>object</code>
结束时是否清空输出

**Kind**: instance method of [<code>Progress</code>](#Progress)  
**Returns**: <code>object</code> - 进度对象  

<!-------------------------------api end flag------------------------------>

<!-------------------------------change logs begin flag--------------------->
# 七、发布日志
 * [2023-09-12 03-25-22]-测试node打包


 * [2023-09-12 02-51-22]-node打包


 * [2023-09-12 02-29-11]-添加进度打印日志
<!-------------------------------change logs end flag----------------------->