Formatter Module

该模块提供了多种格式化函数，包括货币格式化、日期格式化、手机号码安全格式化和姓名安全格式化。

函数列表

• currencyFormater
• dateFormater
• mobileFormater
• nameFormater

currencyFormater

货币格式化函数，用于将数字格式化为带有货币符号和千分位分隔符的字符串。

参数

• num (number): 要格式化的数字
• symbo (string): 货币符号

返回值

string: 格式化后的货币字符串

示例

    import { currencyFormater } from '@jimmy-jin/js-tools';
    console.log(currencyFormater(1234567.89, '$')); // 输出: $ 1,234,567.89

dateFormater

日期格式化函数，用于将日期格式化为指定格式的字符串。

参数

• dateIpt (string | Date): 要格式化的日期
• fmt (string): 格式化字符串

返回值

string: 格式化后的日期字符串

示例

    import { dateFormater } from '@jimmy-jin/js-tools';
    console.log(dateFormater('2023-10-01', 'YYYY-mm-dd')); // 输出: 2023-10-01
    

mobileFormater

手机号码安全格式化函数，用于将手机号码中间四位替换为星号。

参数

• name (string): 要格式化的手机号码

返回值

string | null: 格式化后的手机号码字符串，如果输入为空则返回 null

示例

    import { mobileFormater } from '@jimmy-jin/js-tools';
    console.log(mobileFormater('13812345678')); // 输出: 138****5678
    

nameFormater

姓名安全格式化函数，用于将姓名的第二个字符替换为星号。

参数

• name (string): 要格式化的姓名

返回值

string | null: 格式化后的姓名字符串，如果输入为空则返回 null

示例

    import { nameFormater } from '@jimmy-jin/js-tools';
    console.log(nameFormater('张三')); // 输出: 张*
    

错误处理

每个函数在处理输入时，都会进行必要的检查和处理，以确保格式化结果的正确性。

依赖

无外部依赖。

贡献

欢迎提交问题和贡献代码。

许可证

此项目基于 MIT 许可证。