units-conversion
TypeScript icon, indicating that this package has built-in type declarations

1.2.0-beta.0 • Public • Published

units-conversion

快捷帮忙开发替换单位的库,包含时间,内存大小,数值

安装

npm install units-conversion

引入

// ConverTim - 转换时间
// ConverMemory - 转换内存大小
// ConverValue - 转换数值
// UnitConversionFactory - 自定义
import {
  ConverTim,
  ConverMemory,
  ConverValue,
  UnitConversionFactory,
} from "units-conversion";

使用

1、转换值

转换值不带单位时,默认最小转换

ConverTime.converValue("1000"); // {result: { text: '1', unit: 's', value: '1s' }}
ConverTime.converValue("1000s"); // { result: { text: '17', unit: 'min', value: '17min' }}

2、保留小数

toFixed

默认保留 0 位小数

// 默认不保留小数
ConverTime.converValue("1000"); // { result: { text: '17', unit: 'min', value: '17min' }}

// 保留2位小数
ConverTime.converValue("1000s", { toFixed: 2 }); // {result: { text: '16.67', unit: 'min', value: '16.67min' }}

3、末尾 0 抛弃

abandonZero

默认抛弃末尾没有意义的 0, 通常和 toFixed 连用

// 保留末尾的0
ConverTime.converValue("1000", { toFixed: 2, abandonZero: false }); // {result: { text: '1.00', unit: 's', value: '1.00s' }}

4、单位转换

unitType

默认不开启单位转换(使用内置默认配置中的 key 字段名)

ConverTime.converValue("1000", { toFixed: 2, abandonZero: false }); // {result: { text: '1.00', unit: 's', value: '1.00s' }}

ConverTime.converValue("1000", {
  toFixed: 2,
  abandonZero: false,
  unitType: "zh",
}); // {result: { text: '1.00', unit: '秒', value: '1.00秒' }}

函数说明

行数名称 函数作用 说明
ConverTime 时间转换 converValue--待转化值,小转大, 可带单位; formateConfig
ConverMemory 内存转换 converValue--待转化值,小转大, 可带单位; formateConfig
ConverValue 内存转换 converValue--待转化值,小转大, 可带单位; formateConfig

formateConfig 配置说明

配置 类型 说明 可选值 进度
formateConfig.converTo string 转化到哪一个单位 待完成
formateConfig.unitType string | undefined 使用什么单位 undefined|'zh' 完成
formateConfig.valueType string | undefined 数值转中文,默认不转 undefined|'zh' 完成
formateConfig.toFixed number |undefined 保留几位小数,默认 0 undefined|number 完成
formateConfig.abandonZero boolean | undefined 是否抛弃小数点和后面的 0, 通常和 toFixed 连用 undefined|true|false 完成

内置转换单位枚举

内存大小

  • yb
  • zb
  • pb
  • eb
  • tb
  • gb
  • mb
  • kb
  • b
时间

  • y (年)
  • m(月)
  • w(周)
  • d(天)
  • h(小时)
  • min(分钟)
  • s(秒)
  • ms(毫秒)
数值

  • 千亿
  • 百亿
  • 十亿
  • 亿
  • 千万
  • 百万
  • 十万

UnitConversionFactory 自定义转换类使用说明

import { UnitConversionFactory } from "units-conversion";

let myConver = new UnitConversionFactory([
  { unit: "千亿", zh: "仟", scale: 10 },
  { unit: "百亿", zh: "佰", scale: 10 },
  { unit: "十亿", zh: "拾", scale: 10 },
  { unit: "亿", zh: "亿", scale: 10 },
  { unit: "千万", zh: "仟", scale: 10 },
  { unit: "百万", zh: "佰", scale: 10 },
  { unit: "十万", zh: "拾", scale: 10 },
  { unit: "万", zh: "万", scale: 10 },
  { unit: "千", zh: "仟", scale: 10 },
  { unit: "百", zh: "佰", scale: 10 },
  { unit: "十", zh: "拾", scale: 10 },
  { unit: "", zh: "", scale: 1 },
]);

myConver.converValue("1001百"); // {result: '1十万01百'}
myConver.converValue("1001百", {
  valueType: "zh",
}); // {result: '壹十万零壹百}

版本更新预告

  • 1.2.0
    • 增加日期时间转换?
    • 增加指定转换到
    • 调整代码目录结果
  • 1.1.0 补充说明文档

Package Sidebar

Install

npm i units-conversion

Weekly Downloads

1

Version

1.2.0-beta.0

License

MIT

Unpacked Size

24.6 kB

Total Files

5

Last publish

Collaborators

  • zhangteng520