biu-fn

轻量、直接、类型友好的 TypeScript 函数工具库。当前提供常用的数字千分位格式化能力，适合在业务页面、报表、金额展示和数据面板里快速使用。

特性

• 开箱即用：同时支持 ESM、CommonJS 和 TypeScript 类型声明。
• 输入宽松：支持 number、数字字符串和空值输入。
• 格式稳定：默认保留 2 位小数，并显示千分位分隔符。
• 配置简单：可控制小数位数和是否展示分隔符。

安装

npm install biu-fn

也可以使用你喜欢的包管理器：

pnpm add biu-fn
yarn add biu-fn

快速开始

import { formatThousand } from "biu-fn";

formatThousand(1234567.8);
// '1,234,567.80'

formatThousand("1234567.899");
// '1,234,567.89'

formatThousand(1234567.899, { decimal: 3 });
// '1,234,567.899'

formatThousand(1234567.8, { showSeparator: false });
// '1234567.80'

也支持默认导入：

import fn from "biu-fn";

fn.formatThousand(1234);
// '1,234.00'

API

formatThousand(value, options?)

将数字或数字字符串格式化为带千分位的字符串。

参数

| 参数 | 类型 | 默认值 | 说明 | | ----------------------- | ------------------------------- | ------ | ----------------------------------------------- | | value | number \| string \| undefined | 0 | 要格式化的值。无效值会按 0 处理。 | | options.decimal | number | 2 | 保留的小数位数。小于等于 0 时只保留整数部分。 | | options.showSeparator | boolean | true | 是否显示千分位分隔符。 |

返回值

返回格式化后的字符串。

示例

| 输入 | 配置 | 输出 | | ------------------ | ---------------- | ---------------- | | 1234567 | 默认 | '1,234,567.00' | | 1234567.8 | 默认 | '1,234,567.80' | | 1234567.899 | { decimal: 2 } | '1,234,567.89' | | 1234.5 | { decimal: 0 } | '1,234' | | '1234567.899abc' | 默认 | '1,234,567.89' | | undefined | 默认 | '0.00' |