@zjlab-fe/util 0.2.3 → 0.2.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +21 -0
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,5 +1,26 @@
1
1
  ## API
2
2
 
3
+ ### 格式化展示数字
4
+
5
+ ```javascript
6
+ /**
7
+ * 格式化展示数字,例如:格式化展示文件大小/存储空间大小,或者格式化展示统计个数/次数/条数(纯数字格式化展示)
8
+ * 格式化规则如下:
9
+ * 当语言是中文时,1. >=1亿时,展示成xx亿; 2. >=1万 && <1亿时,展示成xx万; 3. <1万时,展示成xx
10
+ * 当语言是英文时,按照字节单位换算规则返回,比如1000,返回1k, 1000000,返回1M,以此类推
11
+ * @param total {number}
12
+ * @param options {object} 可选,配置项
13
+ * @param options.locale {string} 可选,语言,默认是zh,可选值有zh和en
14
+ * @param options.precision {number} 可选,精度(小数点后最多保留几位),默认是0,即没有小数点
15
+ * @param options.showByte {boolean} 可选,是否是展示字节单位,默认是false
16
+ */
17
+ export declare function formatNumber(total: number, options?: {
18
+ locale?: string;
19
+ precision?: number;
20
+ showByte?: boolean;
21
+ }): string | number;
22
+ ```
23
+
3
24
  ### 下载文件
4
25
 
5
26
  支持多个文件同时下载
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zjlab-fe/util",
3
- "version": "0.2.3",
3
+ "version": "0.2.4",
4
4
  "type": "module",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.esm.js",