在前端开发中,我们常常需要对数字进行格式化,比如将一个整数转换为货币格式、将小数保留一定的位数等等。而在 JavaScript 中,我们可以使用 @craigharvi3/number-formatter 这个 npm 包来方便地进行数字格式化。
安装与引入
要使用 @craigharvi3/number-formatter,需要先安装该包。在终端中输入以下命令即可安装:
npm install @craigharvi3/number-formatter
安装完成后,可以在代码中引入该包:
const numberFormatter = require('@craigharvi3/number-formatter');
也可以使用 ES6 的 import:
import numberFormatter from '@craigharvi3/number-formatter';
API
numberFormatter 提供了两个 API:
format(number, formatString)
unformat(formattedString)
format(number, formatString)
format
方法用于将数字格式化为指定的格式。
第一个参数 number
是要格式化的数字。
第二个参数 formatString
是格式化的模板字符串。
模板字符串中可以包含以下占位符:
#
表示数字。.
表示小数点。,
表示千分位分隔符。%
表示百分比符号。- 任何其他字符将会被原样输出。
例如,要将一个小数格式化为货币格式,可以使用以下代码:
const formattedNumber = numberFormatter.format(1234.567, '¥#,##0.00'); console.log(formattedNumber); // 输出:¥1,234.57
这里的模板字符串为 ¥#,##0.00
,表示要显示货币符号、使用千分位分隔符、保留 2 位小数。
unformat(formattedString)
unformat
方法用于将格式化后的字符串转换为数字。
参数 formattedString
是格式化后的字符串。
例如,要将货币格式的字符串转换为数字,可以使用以下代码:
const formattedNumber = '¥1,234.57'; const number = numberFormatter.unformat(formattedNumber); console.log(number); // 输出:1234.57
示例
以下是一些常见的格式化示例:
numberFormatter.format(1234.567, '#.##'); // 1234.57 numberFormatter.format(1234.567, '#,##0.00'); // 1,234.57 numberFormatter.format(0.4615, '0.00%'); // 46.15% numberFormatter.format(1234567, '0.0a'); // 1.2m numberFormatter.format(1234567, '0.00a'); // 1.23m numberFormatter.format(1234567, '#,##0.00a'); // 1,234.57k
可以看到,在模板字符串中使用不同的占位符,可以格式化出不同的数字格式。
总结
@craigharvi3/number-formatter 是一个非常实用的 npm 包,能够方便地进行数字格式化。通过本文的介绍,我们了解了该包的安装与引入、API 的使用以及一些常见的数字格式化示例,希望对大家有所帮助。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005582481e8991b448d54fd